Skip to content

Commit

Permalink
docs: update release instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
vpicone authored Oct 10, 2020
1 parent c5c58eb commit b175dd0
Showing 1 changed file with 3 additions and 16 deletions.
19 changes: 3 additions & 16 deletions docs/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,23 +13,10 @@ If a patch is narrow in scope(impacting a small subset of sites) we'll hold off
on releasing the patch for the reasons mentioned above.

# How to publish a new theme version
We publish to npm, create a GitHub release, and generate changelogs by using [release-it](https://www.npmjs.com/package/release-it). All of this is tucked behind a single GitHub action which Aux Squad can deploy manually.

1. Checkout `main` and `git pull upstream main`
2. Run `yarn install` to make sure you have the latest version of all the dev
dependencies
3. Determine whether the release is a patch, minor (feature) or major
(breaking). You do this by looking at all of the commits since the last
release:
[https://github.com/carbon-design-system/gatsby-theme-carbon/commits/main](https://github.com/carbon-design-system/gatsby-theme-carbon/commits/main)
4. Type `yarn release X` where `X` is `patch`, `minor`, or `major` from step 2
5. `git push upstream main --follow-tags`
6. Navigate to the theme releases pages and draft a new release:
[https://github.com/carbon-design-system/gatsby-theme-carbon/releases/new](https://github.com/carbon-design-system/gatsby-theme-carbon/releases/new)
1. For tag version, choose the latest tag that was just published
2. Leave title empty
3. Follow the previous release as a template indicating new features and
fixes while linking to relevent documentation as appropriate
7. If this of feature or breaking release, post release notes to Slack channel
1. On the [release workflow](https://github.com/carbon-design-system/gatsby-theme-carbon/actions?query=workflow%3ARelease) page click the `Run workflow` dropdown, then click the green button inside.
2. Wait 10-15s for it to start

# Updating the starter

Expand Down

1 comment on commit b175dd0

@vercel
Copy link

@vercel vercel bot commented on b175dd0 Oct 10, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.