0 Fork 0

mirror of https://github.com/clusterio/clusterio.git synced 2026-11-11 23:04:52 +09:00

Files

T

Hornwitser ab5162e581 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.

2026-03-13 15:33:24 +01:00

2.3 KiB

Raw Blame History

Release workflow

Update changelog

CHANGELOG.md in the repository root
The changelog.txt file in mod directories

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

Note

You will need commit access to the repository as well publish access to the @clusterio org on npm to do this.

Ensure you are on the latest version of master branch with no untracked files
```
git switch master
git pull --ff-only upstream master
git status
```

Bump the version in the package.json files

sed -i 's/2\.0\.0-alpha\.XX/2\.0\.0-alpha\.YY/' {packages,plugins}/*/package.json

Tag and push the release to github

git add -p
git commit -m v2.0.0-alpha.XX
git tag v2.0.0-alpha.XX

Perform a clean install and publish the packages.

pnpm clean
pnpm -r --filter='./{plugins,packages}/*' publish

Plugins

Bump the version in the package.json file
Run pnpm install in the repository root
Run pnpm adduser to authenticate
Run pnpm publish in the plugin/package directory

Before confirming the publish, ensure the packed size is approximately the same size as the last version (or within the expected size)

After publishing, test creating and installing the plugin on a fresh install.

Lua mods

To publish lua mods like clusterio_lib, start by building from source:

pnpm run build-mod

or download the latest artifacts from the CI. When uploading the mods to the mod portal, make sure the latest version is the last version uploaded, as the game/mod portal/ingame updater isn't consistent in how it figures out the "latest version"

Release notes

Release notes are expected to be published alongside new releases. We use the github releases system as well as posting in the #announcements channel on the discord. Major releases may warrant a ping.

2.3 KiB Raw Blame History