From ac686fc38f558f59665b0cb228717a7dbf347150 Mon Sep 17 00:00:00 2001 From: Mike Penz Date: Sat, 2 Nov 2024 10:33:06 +0100 Subject: [PATCH] - add v5 upgrade disclaimer --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5cdf9fe..9470897 100644 --- a/README.md +++ b/README.md @@ -62,6 +62,9 @@ Specify the action as part of your GitHub actions workflow: uses: mikepenz/release-changelog-builder-action@{latest-release} ``` +> [!IMPORTANT] +> When upgrading from v4 to v5, please ensure to read the upgrade warning in the [release notes](https://github.com/mikepenz/release-changelog-builder-action/releases), especially if [regexes](https://github.com/mikepenz/release-changelog-builder-action?tab=readme-ov-file#regex-configuration) are used. + ## Full Sample 🖥️ Below is a complete example showcasing how to define a build, which is executed when tagging the project. It consists of: @@ -69,9 +72,6 @@ Below is a complete example showcasing how to define a build, which is executed - Build changelog, given the tag - Create a release on GitHub - specifying body with a constructed changelog -> [!NOTE] -> Pre v4 PRs will only show up in the changelog if assigned one of the default label categories "feature", "fix" or "test". Starting with v4 these PRs will be in the `Uncategorized` section. -
Example