Skip to content
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.

Sign up for GitHub

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

Update Releasing Docs #528

Merged
merged 3 commits into from
Jul 27, 2018
Merged

Update Releasing Docs #528

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1916f6b
update release branch docs + remove storybook publishing docs
Jul 3, 2018
89e0dd4
fix numbering
Jul 3, 2018
ece2c8a
tweak copy for change log instructions
Jul 3, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 8 additions & 12 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,19 +3,20 @@

### 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 PR and make sure everything that should be merged in 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](https://github.com/primer/primer/blob/master/CHANGELOG.md) file with the change log content from the build.

2. Go through the tracking issue and make sure everything that should be merged in is merged in.
3. Run the version bump in your terminal: `npm run bump`.

3. 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](https://github.com/primer/primer/blob/master/CHANGELOG.md) file.
4. Test your changes with the latest release candidate version in the appropriate places (styleguide, storybook, github/github).

4. Run the version bump in your terminal: `npm run bump`.
5. Once the release PR is approved and you've done necessary testing, merge to `master`. This will trigger a publish to npm.

5. Test your changes with the latest release candidate version in the appropriate places (styleguide, storybook, github/github).
6. Create a new release branch for the next release from `master` and name it `release-<version>`.

6. Once the release PR is approved and you've done necessary testing, merge to `master`. This will trigger a publish to npm.
(CI will publish a release candidate version to npm for branches prefixed with `release`. These version numbers have a `rc.<number>` suffix on them)


### In `github/github`:
Expand Down Expand Up @@ -53,11 +54,6 @@

1. Edit [index.html](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

Expand Down