mikepenz/release-changelog-builder-action
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

- add v5 upgrade disclaimer

Browse Source
This commit is contained in:
Mike Penz
2024-11-02 10:33:06 +01:00
parent f0087fc043
commit ac686fc38f
1 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -3
View File
@@ -62,6 +62,9 @@ Specify the action as part of your GitHub actions workflow:
uses: mikepenz/release-changelog-builder-action@{latest-release} 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 🖥️ ## Full Sample 🖥️
Below is a complete example showcasing how to define a build, which is executed when tagging the project. It consists of: 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 - Build changelog, given the tag
- Create a release on GitHub - specifying body with a constructed changelog - 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.
<details><summary><b>Example</b></summary> <details><summary><b>Example</b></summary>
<p> <p>