-
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
Merged
Merged
Changes from 3 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
70dc7d7
add releasing docs
e6bd185
add link to README
9024c20
minor edits
722a7a5
change link anchor in readme
3c49f4f
changes to updating the styleguide
4d671ff
add staff only to releasing documentation
450c58c
a few more tweaks to releasing docs
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -61,6 +61,10 @@ For a compiled **CSS** version of this module, an npm script is included that wi | |
$ npm run build | ||
``` | ||
|
||
## Releasing | ||
|
||
You can find docs about our release process [here](./RELEASING.md). | ||
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. Can we change the "here" link text to "in RELEASING.md"? |
||
|
||
## Documentation | ||
|
||
You can read more about primer in the [docs][docs]. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
## 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. | ||
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. Could we be more specific here, i.e. npm install primer@latest |
||
|
||
2. In your command line run: `script/update-primer-docs`. | ||
|
||
3. 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 🎉 |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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?