1
1
mirror of https://github.com/primer/css.git synced 2024-12-01 04:21:12 +03:00
css/RELEASING.md
2018-05-14 09:58:56 -07:00

2.5 KiB

Releasing a new Primer version 🎉

In primer/primer:

  1. Create a new release branch from dev and name it release-<version>.

(CI will publish a release candidate version to npm for branches prefixed with release. These version numbers have a rc.<number> suffix on them)

  1. Go through the tracking issue and make sure everything that should be merged in is merged in.

  2. Once your builds finish, click on the details links for the continuous-integration/travis-ci/push build. Expand the Deploying application output and you should be able to find an outputted change log here. Copy this and update the CHANGELOG.md file.

  3. Run the version bump in your terminal: npm run bump.

  4. Test your changes with the latest release candidate version in the appropriate places (styleguide, storybook, github/github).

  5. Once the release PR is approved and you've done necessary testing, merge to master. This will trigger a publish to npm.

In github/github:

  1. Create a new branch

  2. Update the primer version in your terminal npm install primer@<version>.

  3. Update stylelint-config-primer in your terminal to the appropriate version npm install stylelint-config-primer@latest.

  4. If you need to make changes to github/github due to the Primer release, make a separate branch. When ready, merge that branch into your release branch.

  5. Add reviewers.

  6. Check that every deleted vendor file has an accompanying updated vendor file and that the version numbers look correct.

  7. Test on review-lab.

  8. When ready, merge! 🎉

Other items that need to be done after publishing Primer

Update the Style Guide

  1. In github/styleguide, update primer to your newly released version in your terminal:

npm install primer@latest

  1. Then run: script/update-primer-docs.

  2. Commit changes, make PR, get it approved, merge! 🚀

Update primer.github.io

  1. Edit index.html to include the latest version.

Update Storybook

  1. Pull the latest from master on primer/primer (after merging in release branch).

  2. Run npm run publish-storybook.

Publish release tag

  1. Create a new release tag here.

  2. Copy the changes from the CHANGELOG and paste it into the release notes.

  3. Publish 🎉