Skip to content

Commit 4d20230

Browse files
author
Sophia Marie Terry
committed
Update Package release checklist
1 parent f252db0 commit 4d20230

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

tools/spectral/ipa/CONTRIBUTING.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -68,14 +68,18 @@ npm run gen-ipa-docs
6868

6969
- [ ] Reference related issues (e.g., Closes #123)
7070

71-
#### For IPA Package version bump
71+
---
7272

73-
A new version of the IPA package will be released when the version is bumped. Before merging, please run
74-
```
75-
npm run gen-ipa-changelog
76-
```
77-
and commit the changes. The changelog must only be updated alongside a version bump.
73+
## IPA Package Release
74+
75+
A new version of the IPA package will be released when the version in the package.json is changed. To release a new version:
76+
77+
- [ ] Determine whether your update is [major/minor/patch] following [semantic versioning](https://semver.org/)
78+
- [ ] Update the version number in package.json
79+
- [ ] Run `npm run gen-ipa-changelog` and commit the changes.
80+
- [ ] Open a PR and ensure the title is conventional and scoped to IPA (ie: `ci(ipa): new version`)
7881

82+
The changelog must only be updated alongside a version bump. A PR for a version release should not include other changes.
7983
---
8084
## Getting Started with IPA Rule Development
8185

0 commit comments

Comments
 (0)