Skip to content

Commit 8238c6a

Browse files
authored
[WNMGDS-261] - Update NPM publish script (#532)
* remove NPM who am I check. cmsgov account can't be used. * Update release guide
1 parent 0e3cf97 commit 8238c6a

File tree

2 files changed

+25
-22
lines changed

2 files changed

+25
-22
lines changed

guides/RELEASE-PROCESS.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@
2525
git commit -m "Release v1.1.0"
2626
git push --set-upstream origin v1.1.0
2727
```
28-
1. Create a new release on GitHub
28+
1. Create a new release on GitHub
29+
2930
1. [Draft a new release on GitHub](https://github.com/CMSgov/design-system/releases/new)
3031
1. Tag the release using the [SemVer specification release format](#versioning). For example, `v1.1.0`
3132
1. Title the release using the release number. For example, `1.1.0`
@@ -40,37 +41,44 @@
4041
## 🚫 Deprecated
4142
```
4243
43-
**Note**: View commits since the last release on github by going to the [releases page](https://github.com/CMSgov/design-system/releases) or run: ```git log `git describe --tags --abbrev=0`..HEAD --oneline```
44-
44+
**Note**: View commits since the last release on github by going to the [releases page](https://github.com/CMSgov/design-system/releases) or run: `` git log `git describe --tags --abbrev=0`..HEAD --oneline ``
45+
4546
1. **Publish to NPM**
4647
4748
1. Log into NPM as `cmsgov` with `npm adduser`. Check your user account with `npm whoami`.
49+
4850
1. To use an access token, edit your `~/.npmrc` file so the contents are `//registry.npmjs.org/:_authToken={token}`
4951
5052
1. Run the publish to NPM script.
53+
5154
```
5255
./scripts/publish.sh
5356
```
57+
5458
This will run `npm publish` for each public package in `packages/`.
5559
**Note**: You should only publish the `master` branch to NPM. The publish script above will check out the `master` branch if it isn't currently the `HEAD`.
56-
60+
61+
**Note:** You will need to have your own NPM account and get access to the cmsgov NPM org in order to publish.
62+
5763
1. Publish the release notes after the npm package is updated
58-
64+
5965
1. **Update the design.cms.gov documentation website**
6066
6167
1. [Log in to CBJ](https://cloudbeesjenkins.cms.gov/prod-master/job/wds/job/Design%20System/job/Deploy%20design-system/) to Deploy the CMS Design System documentation website.
62-
68+
6369
**Note**: Your CBJ user will need to be a member of the `wd-user` group or you will be unable to see the linked job above.
64-
70+
6571
1. Select the branch you'd like to deploy. The default is set to `master`.
6672
6773
Deploying the documentation website is a multi-stage pipeline that executes the deploy in two stages:
68-
* The first child job builds `design-system`, creates a tarball from the resulting artifacts, then uploads the tarball to S3.
69-
* The second child job downloads the tarball from S3, expands it onto the node Jenkins is using for the deploy, then copies the files to Netstorage via `scp`.
70-
74+
75+
- The first child job builds `design-system`, creates a tarball from the resulting artifacts, then uploads the tarball to S3.
76+
- The second child job downloads the tarball from S3, expands it onto the node Jenkins is using for the deploy, then copies the files to Netstorage via `scp`.
77+
7178
**Note**: For a manual process: Visit the [Documentation deploy process page](https://confluence.cms.gov/display/HCDSG/Documentation+deploy+proces) in Confluence for these instructions.
7279
7380
1. After the new site is deployed, update the visual regression references and put up a PR for the updates.
81+
7482
```
7583
backstop reference
7684
```
@@ -87,24 +95,24 @@ Bug fixes and other minor changes: Increment the last number, e.g. `1.0.1`
8795
8896
Examples:
8997
90-
* Backwards compatible Sass/JS bug fixes
91-
* Tiny visual changes to make the UI more consistent
98+
- Backwards compatible Sass/JS bug fixes
99+
- Tiny visual changes to make the UI more consistent
92100
93101
### Minor release
94102
95103
Backwards compatible new functionality, newly deprecated APIs, or substantial new functionality/improvements to private code: Increment the middle number, e.g. `1.1.0`
96104
97105
Examples:
98106
99-
* Addition of a new component
100-
* New classes, global variables, mixins, functions, or deprecated code
101-
* Minor visual changes to existing components
107+
- Addition of a new component
108+
- New classes, global variables, mixins, functions, or deprecated code
109+
- Minor visual changes to existing components
102110
103111
### Major release
104112
105113
Changes which break backwards compatibility: Increment the first number, e.g. `2.0.0`
106114
107115
Example changes:
108116
109-
* Renamed or removed classes, mixins, functions, placeholders, or global variables.
110-
* Major visual changes to existing components
117+
- Renamed or removed classes, mixins, functions, placeholders, or global variables.
118+
- Major visual changes to existing components

scripts/publish.sh

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,6 @@ RED="\033[0;31m"
66
GREEN='\033[0;32m'
77
NC='\033[0m' # No color
88

9-
if npm whoami | grep cmsgov -v
10-
then
11-
echo "${RED}✘ Not logged in as correct NPM user"
12-
exit 0
13-
fi
149

1510
git stash
1611
git checkout master

0 commit comments

Comments
 (0)