From 70dc7d78b32dbefc3f86ef0d71e65ff9040f4af8 Mon Sep 17 00:00:00 2001 From: Emily Date: Fri, 11 May 2018 12:11:53 -0700 Subject: [PATCH 1/7] add releasing docs --- RELEASING.md | 66 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 RELEASING.md diff --git a/RELEASING.md b/RELEASING.md new file mode 100644 index 0000000000..1bb7871d82 --- /dev/null +++ b/RELEASING.md @@ -0,0 +1,66 @@ +## Releasing a new Primer version 🎉 + + +### In `primer/primer`: + +1. Create a new release branch from `dev` and name it `release-`. + + (CI will publish a release candidate version to npm for branches prefixed with `release`. These version numbers have a `rc.` 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 CHANGELOG here. Copy this and update the CHANGELOG.md file in `primer`. + +4. Run the version bump `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@`. + +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. Update `primer` to the new version. + +2. Run `script/update-primer-docs`. + +3. Make PR, get it approved, merge! 🚀 + +#### Update 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 🎉 From e6bd185f38545579052eeb20eb8cc47577ec31bc Mon Sep 17 00:00:00 2001 From: Emily Date: Fri, 11 May 2018 12:16:08 -0700 Subject: [PATCH 2/7] add link to README --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index b3793fe480..3c423cd7b3 100644 --- a/README.md +++ b/README.md @@ -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). + ## Documentation You can read more about primer in the [docs][docs]. From 9024c204bb157f473eb2011a578cddef35f1b099 Mon Sep 17 00:00:00 2001 From: Emily Date: Fri, 11 May 2018 12:19:55 -0700 Subject: [PATCH 3/7] minor edits --- RELEASING.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index 1bb7871d82..ea91a853a1 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -9,9 +9,9 @@ 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 CHANGELOG here. Copy this and update the CHANGELOG.md file in `primer`. +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 `npm run bump`. +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). @@ -41,13 +41,13 @@ #### Update the Style Guide -1. Update `primer` to the new version. +1. In [github/styleguide](https://github.com/github/styleguide), Update `primer` to your newly released version. -2. Run `script/update-primer-docs`. +2. In your command line run: `script/update-primer-docs`. 3. Make PR, get it approved, merge! 🚀 -#### Update primer.github.io +#### 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. From 722a7a5ce2aebaf005ab5f0600f8c6c8de2abaa8 Mon Sep 17 00:00:00 2001 From: Emily Date: Mon, 14 May 2018 09:46:46 -0700 Subject: [PATCH 4/7] change link anchor in readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3c423cd7b3..cec0542134 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ $ npm run build ## Releasing -You can find docs about our release process [here](./RELEASING.md). +You can find docs about our release process in [RELEASING.md](./RELEASING.md). ## Documentation From 3c49f4f1b83b022221837c07fe4b5d0ea19472ee Mon Sep 17 00:00:00 2001 From: Emily Date: Mon, 14 May 2018 09:49:03 -0700 Subject: [PATCH 5/7] changes to updating the styleguide --- RELEASING.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index ea91a853a1..24bbb2a8d1 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -41,11 +41,13 @@ #### Update the Style Guide -1. In [github/styleguide](https://github.com/github/styleguide), Update `primer` to your newly released version. +1. In [github/styleguide](https://github.com/github/styleguide), update `primer` to your newly released version in your terminal: -2. In your command line run: `script/update-primer-docs`. + `npm install primer@latest` -3. Make PR, get it approved, merge! 🚀 +2. Then run: `script/update-primer-docs`. + +3. Commit changes, make PR, get it approved, merge! 🚀 #### Update [primer.github.io](primer.github.io) From 4d671ffd0a1cb430aef7db5398478eed239ead17 Mon Sep 17 00:00:00 2001 From: Emily Date: Mon, 14 May 2018 09:54:45 -0700 Subject: [PATCH 6/7] add staff only to releasing documentation --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cec0542134..cdd1c12a61 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ For a compiled **CSS** version of this module, an npm script is included that wi $ npm run build ``` -## Releasing +## Releasing (Staff only) You can find docs about our release process in [RELEASING.md](./RELEASING.md). From 450c58cac20387065b375af17beb159b5f7dd66e Mon Sep 17 00:00:00 2001 From: Emily Date: Mon, 14 May 2018 09:58:56 -0700 Subject: [PATCH 7/7] a few more tweaks to releasing docs --- RELEASING.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/RELEASING.md b/RELEASING.md index 24bbb2a8d1..833626e40d 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -9,9 +9,9 @@ 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`. +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. Run the version bump in your command line: `npm run bump`. +4. Run the version bump in your terminal: `npm run bump`. 5. Test your changes with the latest release candidate version in the appropriate places (styleguide, storybook, github/github). @@ -22,9 +22,9 @@ 1. Create a new branch -2. Update the primer version `npm install primer@`. +2. Update the primer version in your terminal `npm install primer@`. -3. Update `stylelint-config-primer` to the appropriate version. +3. Update `stylelint-config-primer` in your terminal to the appropriate version `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. @@ -51,7 +51,7 @@ #### 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. +1. Edit [index.html](https://github.com/primer/primer.github.io/blob/master/index.html) to include the latest version. #### Update Storybook @@ -63,6 +63,6 @@ 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. +2. Copy the changes from the [CHANGELOG](https://github.com/primer/primer/blob/master/CHANGELOG.md) and paste it into the release notes. 3. Publish 🎉