This repository was archived by the owner on Jan 2, 2023. It is now read-only.
File tree Expand file tree Collapse file tree 2 files changed +32
-0
lines changed Expand file tree Collapse file tree 2 files changed +32
-0
lines changed Original file line number Diff line number Diff line change @@ -274,3 +274,7 @@ console.dir(result, {depth: null});
274
274
## Contributing
275
275
276
276
This project does not require a Contributor License Agreement.
277
+
278
+ ### Release Process
279
+
280
+ Release checklist and process is documented in [ Release.md] ( https://github.com/mena-devs/objectron/blob/master/RELEASE.md )
Original file line number Diff line number Diff line change
1
+ # Release
2
+
3
+ ## Semantic versioning
4
+
5
+ Given a version number MAJOR.MINOR.PATCH, increment the:
6
+
7
+ - ` MAJOR ` version when you make incompatible API changes,
8
+ - ` MINOR ` version when you add functionality in a backwards compatible manner, and
9
+ - ` PATCH ` version when you make backwards compatible bug fixes.
10
+
11
+ Additional labels for pre-release and build metadata are available as extensions to the ` MAJOR.MINOR.PATCH ` format.
12
+
13
+ Reference: https://semver.org/
14
+
15
+ ## Pre-release checklist
16
+
17
+ Make sure you cover all the steps below for a new version release.
18
+
19
+ - [ ] Update the release version number in ` package.json `
20
+ - [ ] Capture all the changes / commits in a feature branch
21
+ - [ ] Rebase all changes from upstream to your local master branch
22
+ - [ ] Rebase feature branch with the master branch
23
+ - [ ] Tag the release with the following format: ` MAJOR.MINOR.PATCH `
24
+ - [ ] Push the commits in the master branch and tags upstream
25
+ - [ ] In GitHub actions verify that the new tag passes the ` Build & Test ` workflow
26
+ - [ ] In GitHub create a release from the recently pushed tag
27
+ - [ ] In GitHub actions verify that the ` Publish NPM ` job has completed successfully
28
+ - [ ] Verify that everything is correct in the package's npm page: https://www.npmjs.com/package/@menadevs/objectron
You can’t perform that action at this time.
0 commit comments