mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-21 08:03:13 +09:00
Document release workflow (#738)
This commit is contained in:
1 parent
d622ab5127
commit
febdbd4fd6
1 file changed
+31
@@ -0,0 +1,31 @@
|
|||||||
|
# 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.
|
||||||
|
|
||||||
|
## Plugins and packages
|
||||||
|
|
||||||
|
1. Bump the version in the `package.json` file
|
||||||
|
2. Run `pnpm install` in the repository root
|
||||||
|
3. Run `pnpm adduser` to authenticate
|
||||||
|
4. 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.
|
||||||
Reference in new issue
Block a user