Releasing

Releasing the Web Toolkit currently requires some manual steps. This page describes what you have to do in order to publish a new version.

Clone the Web Toolkit, make sure you've checked out the latest master branch where all your changes are merged into.

1️⃣ Bump the version and tell the world what changed in a couple of words.

yarn version --new-version v2.0.0-alpha.3

💡 We currently bump our prerelease version, which is the last digit in ex. v1.0.0-alpha.1.

The command will do all these things:

• Update version field in your package.json
• Commit the version bump with the provided message
• Add a tag for your newly created version, e.g. v1.2.3

2️⃣ Now push the newly created commit with the version tag to the remote.

git push --follow-tags

3️⃣ Create or update the GitHub release note

If there is a release note already created in our GitHub releases, just connect it to your newly created version tag.

If there's no entry yet, create it by adding release notes from the tags page.

4️⃣ Now build the AXA Web Toolkit

Build the toolkit.

yarn
yarn build

5️⃣ Publish it to npmjs

Finally it's time to publish the built toolkit to npmjs.

npm publish --access public

🚨 Don't forget the --access public, because our package name is scoped, the default is restricted, which we don't want!

☝️ Use npm here, because yarn wants you to bump the version again!

6️⃣ Create the web-toolkit-vX.Y.Z-dist.zip file and upload it to the GitHub release page

yarn release:dist:zip

Then upload the newly generated web-toolkit-vX.Y.Z-dist.zip file to the new GitHub release page.