You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: guides/RELEASE-PROCESS.md
+25-17Lines changed: 25 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,8 @@
25
25
git commit -m "Release v1.1.0"
26
26
git push --set-upstream origin v1.1.0
27
27
```
28
-
1. Create a new release on GitHub
28
+
1. Create a new release on GitHub
29
+
29
30
1. [Draft a new release on GitHub](https://github.com/CMSgov/design-system/releases/new)
30
31
1. Tag the release using the [SemVer specification release format](#versioning). For example, `v1.1.0`
31
32
1. Title the release using the release number. For example, `1.1.0`
@@ -40,37 +41,44 @@
40
41
## 🚫 Deprecated
41
42
```
42
43
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
+
45
46
1. **Publish to NPM**
46
47
47
48
1. Log into NPM as `cmsgov` with `npm adduser`. Check your user account with `npm whoami`.
49
+
48
50
1. To use an access token, edit your `~/.npmrc` file so the contents are `//registry.npmjs.org/:_authToken={token}`
49
51
50
52
1. Run the publish to NPM script.
53
+
51
54
```
52
55
./scripts/publish.sh
53
56
```
57
+
54
58
This will run `npm publish` for each public package in `packages/`.
55
59
**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
+
57
63
1. Publish the release notes after the npm package is updated
58
-
64
+
59
65
1. **Update the design.cms.gov documentation website**
60
66
61
67
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
+
63
69
**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
+
65
71
1. Select the branch you'd like to deploy. The default is set to `master`.
66
72
67
73
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
+
71
78
**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.
72
79
73
80
1. After the new site is deployed, update the visual regression references and put up a PR for the updates.
81
+
74
82
```
75
83
backstop reference
76
84
```
@@ -87,24 +95,24 @@ Bug fixes and other minor changes: Increment the last number, e.g. `1.0.1`
87
95
88
96
Examples:
89
97
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
92
100
93
101
### Minor release
94
102
95
103
Backwards compatible new functionality, newly deprecated APIs, or substantial new functionality/improvements to private code: Increment the middle number, e.g. `1.1.0`
96
104
97
105
Examples:
98
106
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
102
110
103
111
### Major release
104
112
105
113
Changes which break backwards compatibility: Increment the first number, e.g. `2.0.0`
106
114
107
115
Example changes:
108
116
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.
0 commit comments