Skip to content

Commit 0cde731

Browse files
authored
Revise update instructions for version 3.1000
Updated module references and corrected grammatical errors in the documentation for version 3.1000.
1 parent 96be254 commit 0cde731

File tree

1 file changed

+12
-18
lines changed

1 file changed

+12
-18
lines changed

docs/release-information/update-to-version-3-1000/update-platform-and-modules-to-3-1000.md

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -31,21 +31,21 @@ Stability is a cornerstone of this update. By leveraging the advancements in .NE
3131

3232
1. **Install .NET 10:** Begin by ensuring that you have .NET 10 installed on your system. Follow the official installation guidelines to set up the environment for the upgrade: https://dotnet.microsoft.com/en-us/download/dotnet/10.0
3333
2. **Update Virto Commerce Platform to v3.1000 or later**
34-
3. **Update Customer Module and XAPI to v3.1000 or later**
34+
3. **Update [Customer](https://github.com/VirtoCommerce/vc-module-customer) and [XAPI](https://github.com/VirtoCommerce/vc-module-x-api) modules to v3.1000 or later**
3535
4. **Update other Virto Commerce Modules to [Stable Release 12](https://docs.virtocommerce.org/platform/user-guide/1.0/versions/v3-2025-S12/) and later**.
3636

37-
> By default, Virto Commerce Platform on .NET10 are backward compatible with previous platform stable release on .NET8 (3.800+). However, it is recommended to update custom modules to the latest versions to leverage new features and improvements.
37+
> By default, Virto Commerce Platform on .NET10 is backwards compatible with previous platform stable releases on .NET8 (3.800+). However, it is recommended to update custom modules to the latest versions to leverage new features and improvements.
3838
3939
## Known Limitations and Breaking Changes
4040

41-
If you find any new breaking changes, submit an question on [Virto Commerce Community](https://www.virtocommerce.org/c/support/12).
41+
If you find any new breaking changes, submit a question on [Virto Commerce Community](https://www.virtocommerce.org/c/support/12).
4242

4343
### Pomelo.EntityFrameworkCore.MySql v9.0.0
4444
Virto Commerce uses Pomelo.EntityFrameworkCore.MySql 9.0.0 for MySql.
4545

4646
### Exception is thrown when applying migrations if there are pending model changes
4747

48-
Starting with EF Core 9.0, if the model has pending changes compared to the last migration an exception is thrown when dotnet ef database update, Migrate or MigrateAsync is called:
48+
Starting with EF Core 9.0, if the model has pending changes compared to the last migration, an exception is thrown when dotnet ef database update, Migrate or MigrateAsync is called:
4949

5050
The model for context 'DbContext' has pending changes. Add a new migration before updating the database. This exception can be suppressed or logged by passing event ID 'RelationalEventId.PendingModelChangesWarning' to the 'ConfigureWarnings' method in 'DbContext.OnConfiguring' or 'AddDbContext'.
5151

@@ -56,12 +56,12 @@ You can find more information about PendingModelChangesWarning warning by [follo
5656
### Breaking changes in Microsoft.OpenApi
5757

5858
Virto Commerce updated Microsoft.OpenApi from version 1.0.0 to 2.3.0 that includes some breaking changes. You will need to update and rebuild your custom module if you use Microsoft.OpenApi.
59-
You can find more information about Breaking changes in Microsoft.OpenApi by [following link](https://github.com/microsoft/OpenAPI.NET/blob/main/docs/upgrade-guide-2.md).
59+
You can find more information about breaking changes in Microsoft.OpenApi by [following link](https://github.com/microsoft/OpenAPI.NET/blob/main/docs/upgrade-guide-2.md).
6060

6161
## Remove BuildHost-net472 and BuildHost-netcore
6262

6363
After update Microsoft.EntityFrameworkCore.Design to 10.x, you will see that your project includes two folders BuildHost-net472 and BuildHost-netcore under obj folder.
64-
These folders are created by Microsoft.EntityFrameworkCore.Design package to support design-time services for different target frameworks.
64+
These folders are created by Microsoft.EntityFrameworkCore.Design a package to support design-time services for different target frameworks.
6565

6666
You can remove these two folders by modifying your .csproj file to include the following PackageReference for Microsoft.EntityFrameworkCore.Design with PrivateAssets set to all:
6767

@@ -80,17 +80,17 @@ You can get the ModuleTypeLoadingException exception after updating platform and
8080
Unhandled exception. VirtoCommerce.Platform.Core.Modularity.Exceptions.ModuleTypeLoadingException: Failed to load type for module SomeModule.
8181
Cannot load "Microsoft.IO.RecyclableMemoryStream" for module ...
8282
```
83-
In .NET 10, Microsoft refresh and excluded some assemblies (dll) that are no longer needed.
83+
In .NET 10, Microsoft refreshed and excluded some assemblies (dll) that are no longer needed.
8484

85-
To resolve the issue you can:
85+
To resolve the issue, you can:
8686

87-
Option 1. Add module.keep file to your custom module project with the following content, it adds required dll into module package:
87+
Option 1. Add module.keep file in your custom module project with the following content, it adds the required dll into module package:
8888

8989
```txt
9090
Microsoft.IO.RecyclableMemoryStream.dll
9191
```
9292

93-
Option 2. Update your module to .NET 10 using instructions below.
93+
Option 2. Update your module to .NET 10 using the instructions below.
9494

9595
## 415 Client Error: Unsupported Media Type
9696

@@ -120,7 +120,7 @@ vc-build Update -Stable -v 12
120120

121121
### Option 2. Update via package.json
122122

123-
If you use package.json file for automated deployment, change versions of the platform and Virto Commerce modules to 3.1000.0+. Based on latest Stable 8 or Edge release strategy.
123+
If you use package.json file for automated deployment, change versions of the platform and Virto Commerce modules to 3.1000.0+. Based on latest Stable 12 or Edge release strategy.
124124

125125
### Option 3. Manually update
126126

@@ -167,19 +167,13 @@ Download and execute the [vc-net10-update.ps1 Power Shell script](vc-net10-updat
167167
./vc-net10-update.ps1
168168
```
169169

170-
![step1 run ps1 script](../../media/updatenet10-step1-run-ps1-script.png)
171-
172-
![step2 run ps1 script result](../../media/updatenetStable relea-step2-ps1-script-result.png)
173-
174170
This script automates several these tasks, including (of course you can do it manually):
175171

176172
1. Updating the Target Framework to .NET 10 for every project.
177173
2. Updating project dependencies, including Microsoft NuGet dependencies to version 10.0.0 and VirtoCommerce NuGet dependency to version 3.1000.0 and latest.
178-
3. Updating other third-party dependencies to save version that used by Virto Commerce Platform.
174+
3. Updating other third-party dependencies to the version used by Virto Commerce Platform .NET10.
179175
4. Updating the module.manifest file to align with the changes in .NET 10.
180176

181-
![step3 review modified files](../../media/updatenetStable relea-step3-modified-files.png)
182-
183177
### Build Solution
184178

185179
1. Build the solution and meticulously address any compilation errors and warnings if required. This step ensures that the solution is compatible with the updated framework.

0 commit comments

Comments
 (0)