From 879f619721e3158741726bf5d54a0e11829a3208 Mon Sep 17 00:00:00 2001 From: Taylor Jones Date: Wed, 4 Dec 2024 02:51:46 -0600 Subject: [PATCH] chore(docs): separate release commands to individual code blocks (#18190) * chore(docs): separate release commands to individual code blocks * docs(release): update npm auth instructions * Changes wrong commands Hey @tay1orjones I fixed these commands. Last release I noticed that by copying these wasn't working. But these new one were working --------- Co-authored-by: Guilherme Datilio Ribeiro --- docs/release.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 56 insertions(+), 2 deletions(-) diff --git a/docs/release.md b/docs/release.md index 87988cad4710..84dcb64d35d1 100644 --- a/docs/release.md +++ b/docs/release.md @@ -89,6 +89,9 @@ release team will need to do the following: ```bash git checkout main +``` + +```bash git pull upstream main ``` @@ -105,6 +108,9 @@ chore(release): v11.2.0-rc.0 ```bash git tag -a v11.2.0-rc.0 -m 'v11.2.0-rc.0' +``` + +```bash git push upstream v11.2.0-rc.0 ``` @@ -139,6 +145,9 @@ this stage, the release team will do the following: ```bash git checkout main +``` + +```bash git pull upstream main ``` @@ -155,6 +164,9 @@ chore(release): v11.10.0 ```bash git tag -a v11.2.0 -m 'v11.2.0' +``` + +```bash git push upstream v11.2.0 ``` @@ -264,7 +276,7 @@ cases, follow these steps below to ensure a proper patch release: - [ ] Checkout to the tag of the release you want to publish a patch for (most likely the latest release tag, to find the previous release, view the [tag list](https://github.com/carbon-design-system/carbon/tags)). - `git checkout release/vX.Y.Z` + `git checkout vX.Y.Z` - [ ] Create a new release branch with the intended version to be released. Should be the same release that we previously checked out to incremented by +0.0.1 to account for a new patch version. @@ -292,7 +304,13 @@ cases, follow these steps below to ensure a proper patch release: ```bash git add -A + ``` + + ```bash git commit -m 'chore(release): vX.Y.Z' + ``` + + ```bash git push --set-upstream origin release/vX.Y.Z ``` @@ -310,7 +328,10 @@ cases, follow these steps below to ensure a proper patch release: ```bash git tag -a vX.Y.Z -m 'vX.Y.Z' - git push upstream vX.Y.Z + ``` + + ```bash + git push upstream refs/tags/vX.Y.Z ``` - [ ] Verify that your push triggered a release action @@ -326,6 +347,7 @@ cases, follow these steps below to ensure a proper patch release: - Do NOT do this for the carbon-components package. - You need to use the individual generatied version number for the package here, not the released github tag version. + - Ensure you log into the npm cli as `carbon-bot` to avoid auth issues - [ ] for each package (replace carbon-components-react with the package name): @@ -404,7 +426,13 @@ yarn lerna version patch \ ```bash git add -A +``` + +```bash git commit -m 'chore(release): vX.Y.Z' +``` + +```bash git push --set-upstream origin release/vX.Y.Z ``` @@ -417,6 +445,9 @@ git push --set-upstream origin release/vX.Y.Z ```bash git checkout v10 +``` + +```bash git pull upstream v10 ``` @@ -436,6 +467,9 @@ chore(release): v10.59.1 ```bash git tag -a vX.Y.Z -m 'vX.Y.Z' +``` + +```bash git push upstream vX.Y.Z ``` @@ -500,9 +534,21 @@ environment as long as you have push access to the repo. ```bash git checkout main +``` + +```bash git pull upstream main +``` + +```bash git checkout -b `release/vX.Y.Z` +``` + +```bash yarn install +``` + +```bash yarn build ``` @@ -514,7 +560,13 @@ yarn build ```bash git add . +``` + +```bash git commit -m "chore(release): vX.Y.Z" +``` + +```bash git push ``` @@ -551,6 +603,8 @@ package which does not contain a compiled stylesheet. To fix, re-apply the `latest` tag to `v10.x` instead of `v11.x`. Any non-versioned unpkg links should now resolve to `carbon-components@v10.x` again. +- Ensure you log into the npm cli as `carbon-bot` to avoid auth issues. + ```bash npm dist-tag add carbon-components@10.X.Y latest ```