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

docs: update RELEASING.md

Browse Source
This commit is contained in:
Shawn Allen 2019-02-11 13:25:16 -08:00 committed by GitHub
parent 41b56fcc08
commit 705f760693
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
RELEASING.md
View File

@ -1,32 +1,15 @@
## Releasing a new Primer version 🎉
### In `primer/primer`:
### In this repo <a name="in-primerprimer"></a>
1. Check off all of the boxes in your release PR.
1. Go through the tracking PR and make sure everything listed is merged in.
1. Test your changes with the latest release candidate version [in github/github](#in-github-github).
2. To update the changelog for your release, click on the details links for the continuous-integration/travis-ci/push build. Expand the `Deploying application` output and copy the changelog content. Update the [CHANGELOG.md](https://github.com/primer/primer/blob/master/CHANGELOG.md) file with the changelog content from build
1. Once the release PR is approved and you've done necessary testing, merge it. After tests run, the site will be deployed and `@primer/css` will be published with your changes.
**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:
![image](https://user-images.githubusercontent.com/113896/48871307-0be2eb00-ed99-11e8-97ab-b9119ac4b7d3.png)
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. You may need to copy _before_ releasing your mouse to prevent Travis from collapsing that section of the logs first:
![image](https://user-images.githubusercontent.com/113896/48871298-f7065780-ed98-11e8-9160-c1016d61d042.png)
3. Bump the package versions in your terminal:
```sh
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 publishing to npm.
6. 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 the relevant issues and/or pull requests for each change, and removing irrelevant headings:
1. 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 the relevant issues and/or pull requests for each change, and removing irrelevant headings:
```md
# Primer [Major|Minor|Patch] Release
@ -57,10 +40,9 @@
### Ship checklist
- [ ] Update `CHANGELOG.md`
- [ ] Bump versions with `npm run bump`
- [ ] Increment version in `package.json` with `npm version`
- [ ] [Create a new release](https://github.com/primer/primer/releases/new)
- [ ] [Update github/github](https://github.com/primer/primer/blob/master/RELEASING.md#in-githubgithub)
- [ ] [Update github/styleguide](https://github.com/github/styleguide/#adding-new-content-from-primer)
- [ ] Create a new pull request for the next release
/cc @primer/ds-core
@ -71,23 +53,31 @@
1. Create a new branch
2. Update the primer version in your terminal `bin/npm install @primer/css@<version>`.
1. Update the primer version in your terminal `bin/npm install @primer/css@<version>`. [primer/publish](/primer/publish) will create a check status listing the published version.
* If you're working on a release candidate, the `<version>` will be suffixed with `-rc.<sha>`, where `<sha>` is the 7-character SHA of the most recently published commit.
* Otherwise, your work will be published to the `canary` dist-tag as `0.0.0-sha.<sha>`.
3. 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.
1. If you need to make changes to github/github due to the Primer release, do them in a branch and merge _that_ into your release branch after testing.
4. Add reviewers.
1. Add or re-request reviewers and fix any breaking tests.
5. Check that every deleted vendor file has an accompanying updated vendor file and that the version numbers look correct.
1. Test on review-lab.
6. Test on review-lab.
1. Publish `@primer/css` to the `latest` dist-tag by merging the release branch and waiting for the publish action to finish.
7. When ready, merge! 🎉
1. Run `bin/npm install @primer/css@<version>` with the published version and commit the resulting changes.
1. Push your changes and fix any breaking tests.
1. Deploy! :rocket:
### Publish release tag
1. [Create a new release](https://github.com/primer/primer/releases/new) with tag `v<version>`.
2. Copy the changes from the [CHANGELOG](https://github.com/primer/primer/blob/master/CHANGELOG.md) and paste it into the release notes.
2. Copy the changes from the [CHANGELOG] and paste them into the release notes.
3. Publish 🎉
[changelog]: ../CHANGELOG.md