Skip to content

Commit 879f619

Browse files
tay1orjonesguidari
andauthored
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 <[email protected]>
1 parent 9a7eccb commit 879f619

File tree

1 file changed

+56
-2
lines changed

1 file changed

+56
-2
lines changed

docs/release.md

Lines changed: 56 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,9 @@ release team will need to do the following:
8989

9090
```bash
9191
git checkout main
92+
```
93+
94+
```bash
9295
git pull upstream main
9396
```
9497

@@ -105,6 +108,9 @@ chore(release): v11.2.0-rc.0
105108

106109
```bash
107110
git tag -a v11.2.0-rc.0 -m 'v11.2.0-rc.0'
111+
```
112+
113+
```bash
108114
git push upstream v11.2.0-rc.0
109115
```
110116

@@ -139,6 +145,9 @@ this stage, the release team will do the following:
139145

140146
```bash
141147
git checkout main
148+
```
149+
150+
```bash
142151
git pull upstream main
143152
```
144153

@@ -155,6 +164,9 @@ chore(release): v11.10.0
155164

156165
```bash
157166
git tag -a v11.2.0 -m 'v11.2.0'
167+
```
168+
169+
```bash
158170
git push upstream v11.2.0
159171
```
160172

@@ -264,7 +276,7 @@ cases, follow these steps below to ensure a proper patch release:
264276
- [ ] Checkout to the tag of the release you want to publish a patch for (most
265277
likely the latest release tag, to find the previous release, view the
266278
[tag list](https://github.com/carbon-design-system/carbon/tags)).
267-
`git checkout release/vX.Y.Z`
279+
`git checkout vX.Y.Z`
268280
- [ ] Create a new release branch with the intended version to be released.
269281
Should be the same release that we previously checked out to incremented
270282
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:
292304

293305
```bash
294306
git add -A
307+
```
308+
309+
```bash
295310
git commit -m 'chore(release): vX.Y.Z'
311+
```
312+
313+
```bash
296314
git push --set-upstream origin release/vX.Y.Z
297315
```
298316

@@ -310,7 +328,10 @@ cases, follow these steps below to ensure a proper patch release:
310328

311329
```bash
312330
git tag -a vX.Y.Z -m 'vX.Y.Z'
313-
git push upstream vX.Y.Z
331+
```
332+
333+
```bash
334+
git push upstream refs/tags/vX.Y.Z
314335
```
315336

316337
- [ ] Verify that your push triggered a release action
@@ -326,6 +347,7 @@ cases, follow these steps below to ensure a proper patch release:
326347
- Do NOT do this for the <kbd>carbon-components</kbd> package.
327348
- You need to use the individual generatied version number for the package
328349
here, not the released github tag version.
350+
- Ensure you log into the npm cli as `carbon-bot` to avoid auth issues
329351
330352
- [ ] for each package (replace <kbd>carbon-components-react</kbd> with the
331353
package name):
@@ -404,7 +426,13 @@ yarn lerna version patch \
404426

405427
```bash
406428
git add -A
429+
```
430+
431+
```bash
407432
git commit -m 'chore(release): vX.Y.Z'
433+
```
434+
435+
```bash
408436
git push --set-upstream origin release/vX.Y.Z
409437
```
410438

@@ -417,6 +445,9 @@ git push --set-upstream origin release/vX.Y.Z
417445

418446
```bash
419447
git checkout v10
448+
```
449+
450+
```bash
420451
git pull upstream v10
421452
```
422453

@@ -436,6 +467,9 @@ chore(release): v10.59.1
436467
437468
```bash
438469
git tag -a vX.Y.Z -m 'vX.Y.Z'
470+
```
471+
472+
```bash
439473
git push upstream vX.Y.Z
440474
```
441475

@@ -500,9 +534,21 @@ environment as long as you have push access to the repo.
500534

501535
```bash
502536
git checkout main
537+
```
538+
539+
```bash
503540
git pull upstream main
541+
```
542+
543+
```bash
504544
git checkout -b `release/vX.Y.Z`
545+
```
546+
547+
```bash
505548
yarn install
549+
```
550+
551+
```bash
506552
yarn build
507553
```
508554

@@ -514,7 +560,13 @@ yarn build
514560

515561
```bash
516562
git add .
563+
```
564+
565+
```bash
517566
git commit -m "chore(release): vX.Y.Z"
567+
```
568+
569+
```bash
518570
git push
519571
```
520572

@@ -551,6 +603,8 @@ package which does not contain a compiled stylesheet.
551603
To fix, re-apply the `latest` tag to `v10.x` instead of `v11.x`. Any
552604
non-versioned unpkg links should now resolve to `[email protected]` again.
553605

606+
- Ensure you log into the npm cli as `carbon-bot` to avoid auth issues.
607+
554608
```bash
555609
npm dist-tag add [email protected] latest
556610
```

0 commit comments

Comments
 (0)