forked from carbon-design-system/gatsby-theme-carbon
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add script docs to release docs
- Loading branch information
Showing
2 changed files
with
32 additions
and
12 deletions.
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
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 |
---|---|---|
@@ -1,26 +1,48 @@ | ||
# When does the theme publish releases? | ||
At the moment, we intentionally publish releases manually. We want each release to have meaning and reduce constant release churn. For that reason we release when any of the following conditions are true: | ||
|
||
- A bug fix or patch for something in Carbon, IBM Design Language, or the IBM Brand Center sites | ||
At the moment, we intentionally publish releases manually. We want each release | ||
to have meaning and reduce constant release churn. For that reason we release | ||
when any of the following conditions are true: | ||
|
||
- A bug fix or patch for something in Carbon, IBM Design Language, or the IBM | ||
Brand Center sites | ||
- A bug fix that impacts every theme site | ||
- A new feature (includes a corresponding slack announcement) | ||
|
||
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. | ||
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 | ||
|
||
1. Checkout `master` and `git pull upstream master` | ||
2. Run `yarn install` to make sure you have the latest version of all the dev dependencies | ||
2. Determine whether the release is a patch, minor (feature) or major | ||
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/master](https://github.com/carbon-design-system/gatsby-theme-carbon/commits/master) | ||
3. Type `yarn release X` where `X` is `patch`, `minor`, or `major` from step 2 | ||
4. `git push upstream master --follow-tags` | ||
5. Navigate to the theme releases pages and draft a new release: | ||
4. Type `yarn release X` where `X` is `patch`, `minor`, or `major` from step 2 | ||
5. `git push upstream master --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 | ||
6. If this of feature or breaking release, post release notes to Slack channel | ||
7. If this of feature or breaking release, post release notes to Slack channel | ||
|
||
# Updating the starter | ||
|
||
If there's been a feature release/substantial change to the example project, you | ||
should update the gatsby starter kit | ||
|
||
1. Clone the | ||
[starter kit](https://github.com/carbon-design-system/gatsby-starter-carbon-theme) | ||
into your projects directory (wherever you have this project). The clone | ||
should use the default directory name and be siblings with the this project. | ||
1. Be sure your terminal is in the root of the theme project, `checkout master` | ||
and `pull upstream master` | ||
1. In your terminal, type `sh cp-example.sh` | ||
1. Head over to the `gatsby-starter-carbon-theme` directory | ||
1. Add and commit the changes to master then run `git push upstream master` | ||
(it's fine I trust you) :) |