mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-17 15:33:12 +09:00
Add changelog script parsing entries from PRs (#871)
Add script which uses GitHub's REST API to fetch issues and pull requests that have changed since the last release, parse out the changelog entries from merged pull requests, and print a formatted version of the changelog suitable for copying into the release description, the CHANGELOG.md file and the Discord announcement. The script expects Pull Requests to have a `### Changelog` section in them with a code block containing changelog entries. As an added bonus the script can parse out `#<number>` references so that you do not need to write it out in the ugly `[#id](long-url-with-id-repeated)` format. Updates documentation and pull request template to describe the changelog format and usage of the formatting script. Includes improvements from review and a second look.
This commit is contained in:
1 parent
bbd3cc7fdb
commit
ab5162e581
7 files changed
+400
-21
No files matched your search
@@ -137,6 +137,8 @@ You can also pass the `--set-upstream` (or `-u`) flag to make `git push` do the
|
||||
After your feature branch have been merged you should consider it final.
|
||||
If there are more changes you want to have merged or mistakes you need to fix you must start a new feature branch and submit a new pull request.
|
||||
|
||||
Pull request descriptions should contain a `### Changelog` section with additions for the changelog contained inside a code block, see the [CHANGELOG.md](/CHANGELOG.md) file for the formatting of changelog entries and possible sections to use.
|
||||
If there are no changelog entries to add, remove the code block and start the changelog section with the text `None.`, followed by an optional reason for why it is not is needed.
|
||||
|
||||
### Editing your Feature Branch
|
||||
|
||||
|
||||
@@ -5,7 +5,9 @@
|
||||
- CHANGELOG.md in the repository root
|
||||
- The changelog.txt file in mod directories
|
||||
|
||||
Pull requests will usually have suggestions for changelog entries.
|
||||
Pull requests will usually have suggestions for changelog entries. These can be automatically parsed and formatted by running `node scripts/pr_to_changelog.mts`, though you will have to manually sort through which should go in the changelog in the repository root and which should go in the changelogs in mod directories.
|
||||
|
||||
If the script fails due to GitHub's 60/hour public access rate limit, you can set the `GH_TOKEN` environment variable to a fine-grained personal access token which has a much higher rate limits.
|
||||
|
||||
## Packages
|
||||
|
||||
|
||||
Reference in new issue
Block a user