From f2c461ae5c826810f5be05f3a1f297e07a542bbc Mon Sep 17 00:00:00 2001 From: Engincan VESKE Date: Wed, 31 Jul 2024 14:52:42 +0300 Subject: [PATCH 1/3] Create migration guide for v8.3 --- docs/en/Migration-Guides/Abp-8_2.md | 2 +- docs/en/Migration-Guides/Abp-8_3.md | 56 +++++++++++++++++++++++++++++ docs/en/Migration-Guides/Index.md | 1 + 3 files changed, 58 insertions(+), 1 deletion(-) create mode 100644 docs/en/Migration-Guides/Abp-8_3.md diff --git a/docs/en/Migration-Guides/Abp-8_2.md b/docs/en/Migration-Guides/Abp-8_2.md index 5412fe47c0..6cbd2be959 100644 --- a/docs/en/Migration-Guides/Abp-8_2.md +++ b/docs/en/Migration-Guides/Abp-8_2.md @@ -27,7 +27,7 @@ In this version, default padding (padding-top: 1.5rem and padding-bottom: 1.5rem ## Moved members page directory for Blogging Module -With this version on, ABP Framework allows you to use single blog mode, without needing to define a blog and a prefix. With this change, the following namespace changes were done: +With this version on, ABP allows you to use single blog mode, without needing to define a blog and a prefix. With this change, the following namespace changes were done: * `Volo.Blogging.Pages.Blog` -> `Volo.Blogging.Pages.Blogs` * `Volo.Blogging.Pages.Members` -> `Volo.Blogging.Pages.Blogs.Members` (members folder) diff --git a/docs/en/Migration-Guides/Abp-8_3.md b/docs/en/Migration-Guides/Abp-8_3.md new file mode 100644 index 0000000000..3fe6c72737 --- /dev/null +++ b/docs/en/Migration-Guides/Abp-8_3.md @@ -0,0 +1,56 @@ +# ABP Version 8.3 Migration Guide + +This document is a guide for upgrading ABP v8.2 solutions to ABP v8.3. There are some changes in this version that may affect your applications, please read it carefully and apply the necessary changes to your application. + +## Added `AdminUserName` parameter to `IIdentityDataSeeder.SeedAsync` method + +Prior to this version, `IIdentityDataSeeder.SeedAsync` were used to seed the initial user data with the `admin` as the username, to be able to easily test the all application with all permissions granted. + +In this version, we wanted to allow you to set the default **adminUserName**. So, you can set the default user name any name you want or leave it as it is and let the username be `admin` as before. + +For example, in the `MyProjectNameDbMigrationService.SeedDataAsync` method (under the domain project's **Data** folder), you can pass the username as below: + +```diff + private async Task SeedDataAsync(Tenant? tenant = null) + { + Logger.LogInformation($"Executing {(tenant == null ? "host" : tenant.Name + " tenant")} database seed..."); + + await _dataSeeder.SeedAsync(new DataSeedContext(tenant?.Id) + .WithProperty(IdentityDataSeedContributor.AdminEmailPropertyName, IdentityDataSeedContributor.AdminEmailDefaultValue) + .WithProperty(IdentityDataSeedContributor.AdminPasswordPropertyName, IdentityDataSeedContributor.AdminPasswordDefaultValue) ++ .WithProperty(IdentityDataSeedContributor.AdminUserNamePropertyName, "your-admin-user-name") + ); + } +``` + +Normally, you don't need to make any changes related to this change. However, if you used the `IIdentityDataSeeder.SeedAsync` method in your application, it now also gets additional (and optional) `adminUserName` parameter that you can pass value on. + +See the PR for more info: https://github.com/abpframework/abp/pull/20131/ + +## Added RegEx Support to CMS Kit's (PRO) URL Forwarding System + +ABP provides a URL Forwarding system, which allows you to create URLS that redirect to other pages or external websites. Prior to this version, URL Forwarding System was only working for static URLs and wasn't support RegEx. In this version, we introduced the RegEx support for the URL Forwarding System and now you can pass regular expresions for not static URLs. + +Since a new property has been added to the `CmsShortenedUrl` entity, you should create a new migration and apply it to your database. + +> After creating a new migration and applying it to your database, typically you don't need to make any changes, however, if you overridden a page/method or class related to the URL Forwarding System, you might need to update it accordingly. For this purpose, you can get the source code of the [CMS Kit Module's](../modules/cms-kit-pro) and update the related parts in your application. + +## Docs Module: Improvements & Single Project Mode Support + +In this version, we made some improvements in the [Docs Module](../Modules/Docs.md) and introduced single project mode, which allows you to use a single project name for all of your documents. + +While implementing this new feature, we made some small changes in the existing classes. For example, the constructor methods of the following classes have been changed, and needed to be updated in your code, if you use them: + +* `TreeTagHelper.cs`: https://github.com/abpframework/abp/pull/19419/files#diff-e0fb91c1b564d61dedf9dfc60d08e7e0af57b433797fcb3bd664f3fd4768ea0d + +* `MarkdownDocumentToHtmlConverter.cs`: https://github.com/abpframework/abp/pull/19419/files#diff-948e25b2d8851576888f8053b5f2c9416e23576aff95a88ef8ec8ca2841b3622 + +See the PR for more info: https://github.com/abpframework/abp/pull/19419 + +## Updated `datatables.net` to 2.0.2 + +In this version, `datatables.net` library version updated from v1.11.4 to v2.0.2. We made the all related changes in the framework level and updated the dependency and its resource mapping configurations. Also, we made it backward compitable so it should not directly effect your application. + +However, notice this package is used by the `@abp/aspnetcore.mvc.ui.theme.shared` package, which is used by the official themes. Therefore, if you used any methods from the **datatables.net** library it might be depricated or removed. + +See the PR for more info: https://github.com/abpframework/abp/pull/19340 diff --git a/docs/en/Migration-Guides/Index.md b/docs/en/Migration-Guides/Index.md index 2718bc80fb..15a6ff62f4 100644 --- a/docs/en/Migration-Guides/Index.md +++ b/docs/en/Migration-Guides/Index.md @@ -2,6 +2,7 @@ The following documents explain how to migrate your existing ABP applications. We write migration documents only if you need to take an action while upgrading your solution. Otherwise, you can easily upgrade your solution using the [abp update command](../Upgrading.md). +- [8.2 to 8.3](Abp-8_3.md) - [8.x to 8.2](Abp-8_2.md) - [8.0 to 8.1](Abp-8_1.md) - [7.x to 8.0](Abp-8_0.md) From 9674d9ef0a841e8e34cffd429510795c08320a8f Mon Sep 17 00:00:00 2001 From: Engincan VESKE Date: Wed, 31 Jul 2024 15:02:52 +0300 Subject: [PATCH 2/3] Update Abp-8_3.md --- docs/en/Migration-Guides/Abp-8_3.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/en/Migration-Guides/Abp-8_3.md b/docs/en/Migration-Guides/Abp-8_3.md index 3fe6c72737..86c570c485 100644 --- a/docs/en/Migration-Guides/Abp-8_3.md +++ b/docs/en/Migration-Guides/Abp-8_3.md @@ -4,9 +4,9 @@ This document is a guide for upgrading ABP v8.2 solutions to ABP v8.3. There are ## Added `AdminUserName` parameter to `IIdentityDataSeeder.SeedAsync` method -Prior to this version, `IIdentityDataSeeder.SeedAsync` were used to seed the initial user data with the `admin` as the username, to be able to easily test the all application with all permissions granted. +Prior to this version, `IIdentityDataSeeder.SeedAsync` was used to seed the initial user data with the `admin` as the username, to be able to easily test all applications with all permissions granted. -In this version, we wanted to allow you to set the default **adminUserName**. So, you can set the default user name any name you want or leave it as it is and let the username be `admin` as before. +In this version on, we allow you to set the default **adminUserName**. So, you can set the default user name to any name you want or leave it as it is and let the username be `admin` as before. For example, in the `MyProjectNameDbMigrationService.SeedDataAsync` method (under the domain project's **Data** folder), you can pass the username as below: @@ -23,23 +23,23 @@ For example, in the `MyProjectNameDbMigrationService.SeedDataAsync` method (unde } ``` -Normally, you don't need to make any changes related to this change. However, if you used the `IIdentityDataSeeder.SeedAsync` method in your application, it now also gets additional (and optional) `adminUserName` parameter that you can pass value on. +Normally, you don't need to make any changes in your code related to this change. However, if you used the `IIdentityDataSeeder.SeedAsync` method in your application, now also gets additional (and optional) `adminUserName` parameter that you can pass the value on. See the PR for more info: https://github.com/abpframework/abp/pull/20131/ ## Added RegEx Support to CMS Kit's (PRO) URL Forwarding System -ABP provides a URL Forwarding system, which allows you to create URLS that redirect to other pages or external websites. Prior to this version, URL Forwarding System was only working for static URLs and wasn't support RegEx. In this version, we introduced the RegEx support for the URL Forwarding System and now you can pass regular expresions for not static URLs. +ABP provides a [URL Forwarding System](../modules/cms-kit-pro/URL-forwarding), which allows you to create URLs that redirect to other pages or external websites. Prior to this version, the URL Forwarding System was only working for static URLs and didn't support RegEx. In this version, we introduced the RegEx support for the URL Forwarding System and now you can pass regular expressions for not static URLs. Since a new property has been added to the `CmsShortenedUrl` entity, you should create a new migration and apply it to your database. -> After creating a new migration and applying it to your database, typically you don't need to make any changes, however, if you overridden a page/method or class related to the URL Forwarding System, you might need to update it accordingly. For this purpose, you can get the source code of the [CMS Kit Module's](../modules/cms-kit-pro) and update the related parts in your application. +> After creating a new migration and applying it to your database, typically you don't need to make any changes, however, if you have overridden a page/method or class related to the URL Forwarding System, you might need to update it accordingly. For this purpose, you can get the source code of the [CMS Kit Module's](../modules/cms-kit-pro) and update the related parts in your application. ## Docs Module: Improvements & Single Project Mode Support In this version, we made some improvements in the [Docs Module](../Modules/Docs.md) and introduced single project mode, which allows you to use a single project name for all of your documents. -While implementing this new feature, we made some small changes in the existing classes. For example, the constructor methods of the following classes have been changed, and needed to be updated in your code, if you use them: +While implementing this new feature, we made some small changes to the existing classes. For example, the constructor methods of the following classes have been changed, and need to be updated in your code, if you use them: * `TreeTagHelper.cs`: https://github.com/abpframework/abp/pull/19419/files#diff-e0fb91c1b564d61dedf9dfc60d08e7e0af57b433797fcb3bd664f3fd4768ea0d @@ -49,8 +49,8 @@ See the PR for more info: https://github.com/abpframework/abp/pull/19419 ## Updated `datatables.net` to 2.0.2 -In this version, `datatables.net` library version updated from v1.11.4 to v2.0.2. We made the all related changes in the framework level and updated the dependency and its resource mapping configurations. Also, we made it backward compitable so it should not directly effect your application. +In this version, the `datatables.net` library version was updated from v1.11.4 to v2.0.2. We made all related changes at the framework level and updated the dependency and its resource mapping configurations. Also, we made it backward compatible so it should not directly affect your application. -However, notice this package is used by the `@abp/aspnetcore.mvc.ui.theme.shared` package, which is used by the official themes. Therefore, if you used any methods from the **datatables.net** library it might be depricated or removed. +However, notice this package is used by the `@abp/aspnetcore.mvc.ui.theme.shared` package, which is used by the official themes. Therefore, if you used any methods from the **datatables.net** library it might be already deprecated or removed. See the PR for more info: https://github.com/abpframework/abp/pull/19340 From 40e17b9b1703d2be901e79e88b4ddac59ea8286e Mon Sep 17 00:00:00 2001 From: Engincan VESKE Date: Wed, 31 Jul 2024 16:44:56 +0300 Subject: [PATCH 3/3] Finalize v8.3 migration guide --- .../{Abp-8_3.md => abp-8-3.md} | 34 ++++++++++++------- .../en/release-info/migration-guides/index.md | 1 + 2 files changed, 22 insertions(+), 13 deletions(-) rename docs/en/release-info/migration-guides/{Abp-8_3.md => abp-8-3.md} (72%) diff --git a/docs/en/release-info/migration-guides/Abp-8_3.md b/docs/en/release-info/migration-guides/abp-8-3.md similarity index 72% rename from docs/en/release-info/migration-guides/Abp-8_3.md rename to docs/en/release-info/migration-guides/abp-8-3.md index 86c570c485..bc726e68d8 100644 --- a/docs/en/release-info/migration-guides/Abp-8_3.md +++ b/docs/en/release-info/migration-guides/abp-8-3.md @@ -1,8 +1,10 @@ # ABP Version 8.3 Migration Guide -This document is a guide for upgrading ABP v8.2 solutions to ABP v8.3. There are some changes in this version that may affect your applications, please read it carefully and apply the necessary changes to your application. +This document is a guide for upgrading ABP v8.x solutions to ABP v8.3. There are some changes in this version that may affect your applications, please read it carefully and apply the necessary changes to your application. -## Added `AdminUserName` parameter to `IIdentityDataSeeder.SeedAsync` method +## Open-Source (Framework) + +### Added `AdminUserName` parameter to `IIdentityDataSeeder.SeedAsync` method Prior to this version, `IIdentityDataSeeder.SeedAsync` was used to seed the initial user data with the `admin` as the username, to be able to easily test all applications with all permissions granted. @@ -27,17 +29,9 @@ Normally, you don't need to make any changes in your code related to this change See the PR for more info: https://github.com/abpframework/abp/pull/20131/ -## Added RegEx Support to CMS Kit's (PRO) URL Forwarding System - -ABP provides a [URL Forwarding System](../modules/cms-kit-pro/URL-forwarding), which allows you to create URLs that redirect to other pages or external websites. Prior to this version, the URL Forwarding System was only working for static URLs and didn't support RegEx. In this version, we introduced the RegEx support for the URL Forwarding System and now you can pass regular expressions for not static URLs. - -Since a new property has been added to the `CmsShortenedUrl` entity, you should create a new migration and apply it to your database. +### Docs Module: Improvements & Single Project Mode Support -> After creating a new migration and applying it to your database, typically you don't need to make any changes, however, if you have overridden a page/method or class related to the URL Forwarding System, you might need to update it accordingly. For this purpose, you can get the source code of the [CMS Kit Module's](../modules/cms-kit-pro) and update the related parts in your application. - -## Docs Module: Improvements & Single Project Mode Support - -In this version, we made some improvements in the [Docs Module](../Modules/Docs.md) and introduced single project mode, which allows you to use a single project name for all of your documents. +In this version, we made some improvements in the [Docs Module](../../modules/docs.md) and introduced single project mode, which allows you to use a single project name for all of your documents. While implementing this new feature, we made some small changes to the existing classes. For example, the constructor methods of the following classes have been changed, and need to be updated in your code, if you use them: @@ -47,10 +41,24 @@ While implementing this new feature, we made some small changes to the existing See the PR for more info: https://github.com/abpframework/abp/pull/19419 -## Updated `datatables.net` to 2.0.2 +### Updated `datatables.net` to 2.0.2 In this version, the `datatables.net` library version was updated from v1.11.4 to v2.0.2. We made all related changes at the framework level and updated the dependency and its resource mapping configurations. Also, we made it backward compatible so it should not directly affect your application. However, notice this package is used by the `@abp/aspnetcore.mvc.ui.theme.shared` package, which is used by the official themes. Therefore, if you used any methods from the **datatables.net** library it might be already deprecated or removed. See the PR for more info: https://github.com/abpframework/abp/pull/19340 + +## PRO + +> Please check the **Open-Source (Framework)** section before reading this section. The listed topics might affect your application and you might need to take care of them. + +If you are a paid-license owner and using the ABP's paid version, then please follow the following sections to get informed about the breaking changes and apply the necessary ones: + +### Added RegEx Support to CMS Kit's (PRO) URL Forwarding System + +ABP provides a [URL Forwarding System](../../modules/cms-kit-pro/url-forwarding.md), which allows you to create URLs that redirect to other pages or external websites. Prior to this version, the URL Forwarding System was only working for static URLs and didn't support RegEx. In this version, we introduced the RegEx support for the URL Forwarding System and now you can pass regular expressions for not static URLs. + +Since a new property has been added to the `CmsShortenedUrl` entity, you should create a new migration and apply it to your database. + +> After creating a new migration and applying it to your database, typically you don't need to make any changes, however, if you have overridden a page/method or class related to the URL Forwarding System, you might need to update it accordingly. For this purpose, you can get the source code of the [CMS Kit Module's](../../modules/cms-kit-pro/index.md) and update the related parts in your application. \ No newline at end of file diff --git a/docs/en/release-info/migration-guides/index.md b/docs/en/release-info/migration-guides/index.md index e884b70f9f..7ff07eda10 100644 --- a/docs/en/release-info/migration-guides/index.md +++ b/docs/en/release-info/migration-guides/index.md @@ -2,6 +2,7 @@ The following documents explain how to migrate your existing ABP applications. We write migration documents only if you need to take an action while upgrading your solution. Otherwise, you can easily upgrade your solution using the [abp update command](../upgrading.md). +- [8.x to 8.3](abp-8-3.md) - [8.0 to 8.1](abp-8-1.md) - [7.x to 8.0](abp-8-0.md) - [7.3 to 7.4](abp-7-4.md)