Skip to content

Commit b671ebc

Browse files
committed
add info about the release notes to the readme
1 parent 7d60a4b commit b671ebc

File tree

1 file changed

+17
-10
lines changed

1 file changed

+17
-10
lines changed

README.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -122,17 +122,24 @@ npm run watch-lib # use when you want to build the library for local use; it wil
122122
```
123123
124124
## Cutting a New Release
125-
A git tag should exist for every release. We use `release-it` to automate the coordination of package.json and git tag.
125+
A git tag should exist for every semver release. We use `release-it` to automate the coordination of package.json and git tag.
126+
127+
1. run `npm run release`. You'll be entered into an interactive session with the following prompts:
128+
``` bash
129+
? Select increment # You will be prompted to select a release type, e.g. patch
130+
? Publish @scientist-softserv/webstore-component-library to npm? # Yes
131+
? Please enter OTP for npm: # This is stored in 1password
132+
? Commit (chore: release vX.X.X)? # Yes
133+
? Tag (X.X.X)? # Yes
134+
? Push? # Yes
135+
```
126136

127-
If you want to release a new semver release run `npm run release`. You'll be entered into an interactive session with the following prompts:
128-
``` bash
129-
? Select increment (You will be prompted to select a release type, e.g. patch)
130-
? Publish @scientist-softserv/webstore-component-library to npm? (Yes)
131-
? Please enter OTP for npm: (This is stored in 1password)
132-
? Commit (chore: release vX.X.X)? (Yes)
133-
? Tag (X.X.X)? (Yes)
134-
? Push? (Yes)
135-
```
137+
2. When the above completes, [create the release notes](https://github.com/scientist-softserv/webstore-component-library/releases/new).
138+
- Choose the tag that was just released
139+
- Set the title of the release to be the newly released version
140+
- e.g. "0.1.16"
141+
- Click the "Generate release notes" button above the text field
142+
- Click the "Publish release" button beneath the text field
136143

137144
## Authors and acknowledgment
138145
Alisha Evans

0 commit comments

Comments
 (0)