-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add release documentation #490
Changes from 5 commits
70dc7d7
e6bd185
9024c20
722a7a5
3c49f4f
4d671ff
450c58c
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
## 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) | ||
|
||
2. Go through the tracking issue and make sure everything that should be merged in is merged in. | ||
|
||
3. Once your builds finishes, 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 in `primer`. | ||
|
||
4. Run the version bump in your command line: `npm run bump`. | ||
|
||
5. Test your changes with the latest release candidate version in the appropriate places (styleguide, storybook, github/github). | ||
|
||
6. 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 `npm install primer@<version>`. | ||
|
||
3. Update `stylelint-config-primer` to the appropriate version. | ||
|
||
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](https://github.com/github/styleguide), update `primer` to your newly released version in your terminal: | ||
|
||
`npm install primer@latest` | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oh weird! It's only using single backticks but maybe the spacing is off 🤔 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yeah, I think it's un-indented because it's on a new line and not indented 4 spaces. |
||
|
||
2. Then run: `script/update-primer-docs`. | ||
|
||
3. Commit changes, make PR, get it approved, merge! 🚀 | ||
|
||
#### Update [primer.github.io](primer.github.io) | ||
|
||
1. Edit index.html [here](https://github.com/primer/primer.github.io/blob/master/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](https://github.com/primer/primer/releases/new). | ||
|
||
2. Copy the changes from the CHANGELOG and paste it into the release notes. | ||
|
||
3. Publish 🎉 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we add something indicating releasing is only something Staff can do, or is that obvious enough?