Merge pull request #5 from mena-devs/develop

Update pipelines & prepare release 0.1.9

Author: Bassem Dghaidi

.github/workflows/build.yml

@@ -5,7 +5,7 @@ name: Build & Test
 
 on:
   push:
-    branches: [ master ]
+    branches: [ master, develop ]
   pull_request:
     branches: [ master ]
 

.github/workflows/publish.yml

@@ -29,4 +29,4 @@ jobs:
       - run: npm ci
       - run: npm publish
         env:
-          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -274,3 +274,7 @@ console.dir(result, {depth: null});
 ## Contributing
 
 This project does not require a Contributor License Agreement.
+
+### Release Process
+
+Release checklist and process is documented in [Release.md](https://github.com/mena-devs/objectron/blob/master/RELEASE.md)

RELEASE.md

@@ -0,0 +1,29 @@
+# Release
+
+## Semantic versioning
+
+Given a version number MAJOR.MINOR.PATCH, increment the:
+
+- `MAJOR` version when you make incompatible API changes,
+- `MINOR` version when you add functionality in a backwards compatible manner, and
+- `PATCH` version when you make backwards compatible bug fixes.
+
+Additional labels for pre-release and build metadata are available as extensions to the `MAJOR.MINOR.PATCH` format.
+
+Reference: https://semver.org/
+
+## Pre-release checklist
+
+Make sure you cover all the steps below for a new version release.
+
+- [ ] Update the release version number in `package.json`
+- [ ] Merge your feature branch with the `develop` branch
+- [ ] Rebase all changes from upstream to your local develop branch
+- [ ] Create a pull request from the `develop` branch to the master branch
+- [ ] Make sure the title of your pull request contains the new release version
+- [ ] In GitHub actions verify that your pull request passes the `Build & Test` workflow
+- [ ] Get your pull request reviewed by at least 1 other contributor to the project
+- [ ] If all the checks and code reviews are done, `rebase and merge` the develop branch with the `master` branch
+- [ ] In GitHub create a tag and a release from the recently merged pull request
+- [ ] In GitHub actions verify that the `Publish NPM` job has completed successfully
+- [ ] Verify that everything is correct in the package's npm page: https://www.npmjs.com/package/@menadevs/objectron

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@menadevs/objectron",
-  "version": "0.1.8",
+  "version": "0.1.9",
   "description": "Compares a set of match rules contained with an object to determine if the latter conforms to the matching rules",
   "main": "index.js",
   "devDependencies": {