Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Upgrade command doc #19973

Closed
wants to merge 5 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 22 additions & 2 deletions docs/en/cli/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,12 @@ Here, is the list of all available commands before explaining their details:
* **`login`**: Authenticates on your computer with your [abp.io](https://abp.io/) username and password.
* **`login-info`**: Shows the current user's login information.
* **`logout`**: Logouts from your computer if you've authenticated before.
* **`upgrade`**: Upgrades solution with Pro modules
* **`bundle`**: Generates script and style references for ABP Blazor and MAUI Blazor project.
* **`install-libs`**: Install NPM Packages for MVC / Razor Pages and Blazor Server UI types.
* **`clear-download-cache`**: Clears the templates download cache.
* **`trust-version`**: Trusts the user's version and does not check if the version exists or not. If the template with the given version is found in the cache, it will be used, otherwise throws an exception.

### help

Shows basic usages of the ABP CLI.
Expand Down Expand Up @@ -616,7 +617,7 @@ Deletes a remote module source from the list of sources that you can use to inst

````bash
abp delete-module-source [options]
````
````

Example:

Expand Down Expand Up @@ -860,6 +861,25 @@ Logs you out by removing the session token from your computer.
```bash
abp logout
```
### upgrade

Upgrades the solution with Pro modules. Especially designed for users who already started their development before having a license. Therefore this command requires license. For more info, see [the related document](../studio/upgrade-to-pro.md) .

````bash
abpc upgrade [options]
````

Example:

````bash
abpc upgrade -t app

abpc upgrade -t app-nolayers
````

#### options

* `--template` or `-t`: The template type of the solution. Only `app` and `app-nolayers` are valid currently.

### bundle

Expand Down
Binary file added docs/en/studio/images/upgrade-to-pro.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
44 changes: 44 additions & 0 deletions docs/en/studio/upgrade-to-pro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Upgrading existing solution with Pro modules

ABP Studio provides a way for users, who already started the development before purchasing a license, to auto-upgrade their solutions with Pro modules.

![upgrade-to-pro](D:\github\abp\docs\en\studio\images\upgrade-to-pro.png)

## Changes in the solution

### Module changes

This command will remove the following modules from your solution:

- Volo.Abp.Account
- Volo.Abp.Identity
- Volo.Abp.TenantManagement
- Volo.Abp.LeptonXLiteTheme

And install the following modules to your solution:

- Volo.Abp.Account.Pro
- Volo.Abp.AuditLogging.Pro
- Volo.Abp.Identity.Pro
- Volo.Abp.OpenIddict.Pro
- Volo.Saas
- Volo.Abp.LanguageManagement
- Volo.Abp.TextTemplateManagement
- Volo.FileManagement
- Volo.Chat
- Volo.Abp.Gdpr
- Volo.Abp.LeptonXTheme

### Other changes

The command will also do the following changes in your solution:

- It will add the commercial NuGet source to `NuGet.config` file.
- It will create or update `appsettings.secrets.json` files to place the license key needed for Pro module usage.
- It will update the database. (And it will create a new migration if the solution uses EntityFramework Core)
- It will run `install-libs` & `bundle` commands at the end.

## Things to pay attention before using

- The command covers the most common scenarios, but there is still a possiblity that it can mess up something in your solution. Therefore, we strongly recommend a source code control system (like GitHub) to track what is changed in your solution and revert if needed.
- The command will not remove your custom codes that may be related with the removed modules listed above. So there may be build errors if you referenced one those modules. You can clear them manually.
Loading