release-process.md

Release process

Table of contents

• Pre release tasks
• Releasing
  • Releasing on GitHub
  • Releasing to NPM
  • Releasing to assets server
• Deploying vanillaframework.io
• Releasing React Components
• Promotion

Pre release tasks

• Merge all pull requests relating to the given release
• On GitHub releases page update latest draft automatically created by Release Drafter
  • make sure automatic version is correct
  • clean up the log from unnecessary lines, move changes to relevant section if it didn't happen automatically based on labels, reword the changes for better readability

Releasing

• Pull locally latest version from the main branch
• dotrun build
  • make sure everything builds without any errors
• dotrun test
  • make sure all test pass

Releasing on GitHub

• Publish the latest release on Github with the new version number and add the release notes you created earlier.
  • Make sure to mark the release as a pre-release if it's an Alpha or Beta

Releasng to NPM

This should happen automatically after publishing the release on GH (thanks to GH actions workflow).

In case that fails, here are manual steps to release to NPM:

• Update your local tags with git fetch --tags
• Check out the tag with git checkout TAGNAME
• Publish the package with npm publish and check that your new release appears on the NPM website

Releasing to assets server

This should happen automatically after publishing the release on GH (thanks to GH actions workflow).

In case that fails, here are manual steps to release to assets server:

• dotrun build
• upload-assets --url-path vanilla-framework-version-X.X.X.min.css build/css/build.css

Deploying vanillaframework.io

• Staging should be automatically deployed on every push to the main branch
• Test the staging build
• Deploy to production on https://webteam.canonical.com/releases
  • or Deploy the site to production directly on jenkins

Releasing React Components

When the Vanilla npm package is published, react-components project should be updated to latest version of Vanilla (renovate should prepare an update PR) and the updated react-components package should be published as well.

Please follow the release process documented in the react-components repository.

Promotion

Only major/minor releases need to be promoted.

• New releases should be announced on newsletter via MailChimp
• New releases should be announced on the @vanillaframewrk twitter account
  • this should happen automatically when newsletter is sent
• Major and minor releases should also be announced in detail on the ubuntu blog