Nativefier/docs/release.md

1.1 KiB

Release

Releases are automatically deployed to npm from Travis, when they are tagged. However, we have to make sure that the version in the package.json, and the changelog is updated.

Tests

Before anything, run a little manual smoke test of some of our hard-to-programatically-test features:

npm run test:manual

How to release

With Git Extras and jq installed.

While on master, with no uncommitted changes,

npm run changelog -- $VERSION
# For example, npm run changelog -- 7.7.1

This command does 3 things:

  1. Update the version in the package.json
  2. Update the changelog
  3. Creates a new commit with the changes

Now we may want to cleanup the changelog:

vim CHANGELOG.md
git commit --amend

Once we are satisfied,

git tag vX.Y.Z
git push --follow-tags origin master

On GitHub Releases, draft and publish a new release with title Nativefier vX.X.X (yes, with a v).

The new version will be visible on npm within a few minutes/hours.