Skip to content

Commit

Permalink
chore: update release docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vpicone committed Apr 1, 2021
1 parent f4551c1 commit 7d174db
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 6 deletions.
15 changes: 12 additions & 3 deletions docs/releases.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,19 @@ 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. 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
We publish to npm, create a GitHub release, and generate changelogs by using
[release-it](https://www.npmjs.com/package/release-it). To practice, use
`yarn release:dry` in step 2. This will take you through the whole process, but
not actually do anything.

1. Grab the latest changes. On the `main` branch, run
`git pull upstream main --tags`
2. Run `yarn release` and check the generated changelog
3. If there's a new feature, ensure we're bumping up the second number in the
new version (`1.X`)
4. Complete the prompts
5. 🚀 You did it! 🥳

# Updating the starter

Expand Down
5 changes: 2 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,9 @@
"format": "prettier --write \"**/*.{css,scss,json,html,yaml,mdx}\"",
"lint:js": "eslint . --fix",
"lint:scss": "stylelint \"packages/**/*.scss\" --fix",
"pre:release": "git pull upstream main --tags",
"release": "npm run pre:release && release-it",
"release": "release-it",
"release:ci": "release-it --ci",
"release:dry": "release-it --ci --dry-run"
"release:dry": "release-it --dry-run"
},
"publishConfig": {
"registry": "https://registry.npmjs.org"
Expand Down

0 comments on commit 7d174db

Please sign in to comment.