MainsBot

Releasing

This repo now uses package.json as the canonical app version source. The web footer and !version output both read from it through the build info helper.

Standard release flow

1. Make sure the branch is clean

git status

If the tree is not clean, commit or intentionally discard the changes first.

2. Bump the version

For major/minor/patch releases:

npm version major --no-git-tag-version

npm version minor --no-git-tag-version

npm version patch --no-git-tag-version

If you are setting a specific release directly:

npm version 3.0.0 --no-git-tag-version

That updates:

package.json
package-lock.json

3. Update release notes

Edit:

CHANGELOG.md

Put the newest release entry at the top.

4. Commit the release

git add package.json package-lock.json CHANGELOG.md README.md RELEASING.md
git commit -m "release: v3.0.0"

5. Tag it

Use annotated tags:

git tag -a v3.0.0 -m "MainsBot v3.0.0"

6. Push branch and tag

git push origin master
git push origin v3.0.0

If your default branch is not master, use the correct branch name.

GitHub release page

After the tag is pushed:

Open the repository on GitHub.
Go to Releases.
Click Draft a new release.
Select the tag, for example v3.0.0.
Title it MainsBot v3.0.0.
Paste the matching CHANGELOG.md section into the release notes.
Publish the release.

Recommended release notes format

Use the same section layout as the changelog:

Added
Changed
Fixed
Removed
Operational notes

Deploy after release

On the server:

cd /opt/mainsbot
git fetch origin
git checkout master
git pull --ff-only
npm install
sudo systemctl restart mainsbot@<instance>
sudo systemctl restart mainsbot-web@<instance>

Quick sanity checks

After deploy:

node -p "require('./package.json').version"
journalctl -u mainsbot@<instance> -n 50 --no-pager
journalctl -u mainsbot-web@<instance> -n 50 --no-pager

Then verify:

footer shows the new version
!version returns the new build version
/api/status returns the updated build metadata

This site is open source. Improve this page.