Skip to content

Commit b342408

Browse files
authored
Merge pull request #1293 from ml5js/joeyklee.devops-updates-docs
docs: updates docs with latest release process
2 parents a409ffe + bc59ae1 commit b342408

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

Diff for: docs/styleguide/maintenance-notes.md

+13-15
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,28 @@
66

77
1. make sure to tag it with one of the following in the PR:
88
- SEMVER/patch
9+
- e.g. `SEMVER/patch`: `0.8.11` would become -> `0.8.12`
910
- SEMVER/minor
11+
- e.g. `SEMVER/minor`: `0.8.11` would become -> `0.9.0`
1012
- SEMVER/major
13+
- e.g. `SEMVER/major`: `0.8.11` would become -> `1.0.0`
1114

12-
## Before tagging a release releasing: bump the package version
13-
1. open a PR to bump the package version: e.g. `git checkout -b v0.8.12`
14-
2. bump the package version number that matches the `SEMVER/patch | SEMVER/minor | SEMVER/major`
15-
- e.g. `SEMVER/patch`: `0.8.11` would become -> `0.8.12`
16-
- e.g. `SEMVER/minor`: `0.8.11` would become -> `0.9.00`
17-
- e.g. `SEMVER/major`: `0.8.11` would become -> `1.0.0`
18-
3. run `npm i` <--- this makes sure your bumped package version makes it into the `package-lock.json`
19-
4. run `npm run update:readme` <----- captures the version bump in the readme
20-
5. run `git add .`
21-
6. run `git commit -m "chore: bumps package"`
22-
7. push this to your feature branch.
23-
8. make a PR and merge to `main`
15+
NOTE: if you are unsure quite likely it will be a `SEMVER/patch` for "...when you make backwards compatible bug fixes.". You can learn more about [Semantic Versioning](https://semver.org/).
2416

2517
## Once we merge the PR to `main`:
18+
2619
1. simply go to the `releases` sidebar >
2720
<img width="1332" alt="Screen Shot 2022-01-21 at 12 58 26 PM" src="https://user-images.githubusercontent.com/3622055/150599297-44e00536-9399-4cc0-be5b-d0b09761d651.png">
2821
2. go to the latest draft and click the edit button
2922
<img width="1332" alt="Screen Shot 2022-01-21 at 12 58 31 PM" src="https://user-images.githubusercontent.com/3622055/150599360-cba6d7ec-44eb-49da-977a-a7de5f071795.png">
30-
3. click: publish the release
31-
32-
23+
3. click: publish the release -- this will trigger a github workflow that will:
24+
* get the latest tag version
25+
* update the package.json
26+
* update the readme with the latest version (pulled from the package.json)
27+
* run npm install
28+
* add, commit, and push those changes to `main`
29+
* build the library
30+
* and publish to npm
3331

3432

3533
***

0 commit comments

Comments
 (0)