primer/css
1
1
Fork 0
mirror of https://github.com/primer/css.git synced 2024-11-13 08:04:16 +03:00
Code Issues Projects Releases Wiki Activity
89f253f896
css/RELEASING.md
Shawn Allen 89f253f896
update releasing docs 
- remove link to primer.github.io (this is a redirect now)
- link to new release view
- prompt to merge the PR before doing 
- provide better guidance on copying the changelog text from Travis logs
- add all the change category headings to the release PR template
2018-11-20 14:21:30 -08:00

3.8 KiB
Raw Blame History

Releasing a new Primer version 🎉

In primer/primer:

  1. Go through the tracking PR and make sure everything listed is merged in.

  2. To update the change log for your release, click on the details links for the continuous-integration/travis-ci/push build. Expand the Deploying application output and copy the change log content. Update the CHANGELOG.md file with the change log content from build

    Note: the CHANGELOG contents may be hidden within a collapsed section of the Travis logs under Deploying the application. Click the ▶ to the left of that section to expand it, then scroll to the bottom of the page, and copy all of the text between the Unreleased (YYYY-MM-DD) heading and the exit status message (e.g. Done. Your build exited with 0.). You may need to copy before releasing your mouse to prevent Travis from collapsing that section of the logs first.

  3. Bump the package versions in your terminal:

npm run bump

  1. Run script/check-versions to catch any cross-module version mismatches. (This will run on Travis, too.)

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

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

  4. Create a new release branch for the next release from master and name it release-<version>. Please use the following template for the PR description, linking to pull the relevant issues and/or pull requests for each change, and removing irrelevant headings:

    # Primer [Major|Minor|Patch] Release

Version: 📦 **0.0.0**
Approximate release date: 📆 DD/MM/YY

### :boom: Breaking Change
- [ ] Description #

### :rocket: Enhancement
- [ ] Description #

### :bug: Bug Fix
- [ ] Description #

### :nail_care: Polish
- [ ] Description #

### :memo: Documentation
- [ ] Description #

### :house: Internal
- [ ] Description #

----

### Ship checklist

- [ ] Update `CHANGELOG.md`
- [ ] Run version bump
- [ ] Create a [new release](https://github.com/primer/primer/releases/new)
- [ ] Update github/github with released version
- [ ] Update github/styleguide with released version
- [ ] Create a new pull request for the next release

/cc @primer/ds-core

In github/github:

  1. Create a new branch

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

  3. Update stylelint-config-primer in your terminal to the appropriate version bin/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.

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 🎉