Skip to content

Commit 9d43997

Browse files
authored
add release notes instruction (#193)
1 parent e3a4ee7 commit 9d43997

File tree

1 file changed

+27
-10
lines changed

1 file changed

+27
-10
lines changed

CONTRIBUTING.md

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Welcome to the ml5.js project! Developing ml5.js is not just about developing ma
1616
- [For Command Line](#for-command-line)
1717
- [Building the Library](#building-the-library)
1818
- [Making Releases](#making-releases)
19+
- [Release Notes](#release-notes)
1920
- [Unit Tests](#unit-tests)
2021
- [Update p5 Web Editor Sketches](#update-p5-web-editor-sketches)
2122
- [All Contributors](#all-contributors)
@@ -156,44 +157,60 @@ This will create a production version of the library in `/dist` directory.
156157

157158
3. Commit the changes. Then, make a pull request from the new branch to main and merge it.
158159

159-
4. Switch to the main branch and make sure the code is up to date by running the following command:
160+
4. Make a release note about the new release on GitHub. Check the [Release Notes](#release-notes) section for detailed instruction.
161+
162+
5. Switch to the main branch and make sure the code is up to date by running the following command:
160163

161164
```
162165
git checkout main
163166
git pull
164167
```
165168

166-
5. Make sure all dependencies have been installed by running the following command:
169+
6. Make sure all dependencies have been installed by running the following command:
167170

168171
```
169172
yarn
170173
```
171174

172-
6. Build the project with the following command and wait for the build to complete:
175+
7. Build the project with the following command and wait for the build to complete:
173176

174177
```
175178
yarn run build
176179
```
177180

178-
7. Run the following command and log in with an npm account that has write access to the `ml5` package. You may be redirected to a browser window for authentication.
181+
8. Run the following command and log in with an npm account that has write access to the `ml5` package. You may be redirected to a browser window for authentication.
179182

180183
```
181184
npm login
182185
```
183186

184-
8. Publish the package with the following command. You may be redirected to a browser window for authentication.
187+
9. Publish the package with the following command. You may be redirected to a browser window for authentication.
185188

186189
```
187190
npm publish --access public
188191
```
189192

190-
9. The package should now be available at. (Replace `<version>` with the new SemVer set in step 1).
193+
10. The package should now be available at. (Replace `<version>` with the new SemVer set in step 1).
191194

192-
```
193-
https://unpkg.com/ml5@<version>/dist/ml5.js
194-
```
195+
```
196+
https://unpkg.com/ml5@<version>/dist/ml5.js
197+
```
198+
199+
11. Update the example code on the p5 web editor. Follow the instructions in the [Update p5 Web Editor Sketches](#update-p5-web-editor-sketches) section.
200+
201+
## Release Notes
202+
203+
ml5.js produce release notes alongside each new release. The release notes provides a brief overview of the changes, updates, and additions made to the ml5.js library. This section is a brief guide on generating release notes on GitHub.
195204
196-
10. Update the example code on the p5 web editor. Follow the instructions in the [Update p5 Web Editor Sketches](#update-p5-web-editor-sketches) section.
205+
1. Go to [ml5's Releases Page](https://github.com/ml5js/ml5-next-gen/releases) on Github.
206+
2. Click on **Draft a new release**.
207+
3. Click on **Choose a tag** and enter the version number of the new release in the format of `v<major>.<minor>.<patch>`. For example, `v1.0.3`.
208+
4. Click on **Create new tag: vx.x.x on publish**.
209+
5. For the **Target**, make sure `main` is selected.
210+
6. For the **Previous tag**, select the previous release. For example, if the new release is `v1.0.3`, select tag `v1.0.2`.
211+
7. Click on **Generate release notes**, and a release note will be automatically generated. If needed, make manual edits to the release note.
212+
8. Make sure **Set as the latest release** is selected and click **Publish release**.
213+
9. You just created a new release note!
197214
198215
## Unit Tests
199216

0 commit comments

Comments
 (0)