From bb5641f7cbd361a4fd9a6994051c47976cf3dda3 Mon Sep 17 00:00:00 2001 From: Bassem Dghaidi Date: Fri, 1 May 2020 16:43:53 +0200 Subject: [PATCH 1/5] Fix remove testing matrix, one environment is enough --- .github/workflows/publish.yml | 9 +++------ 1 file changed, 3 insertions(+), 6 deletions(-) diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 49168f2..443c4f2 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -9,16 +9,13 @@ jobs: npm-publish: name: npm-publish runs-on: ubuntu-latest - strategy: - matrix: - node-version: [10.x, 12.x] steps: - name: Checkout repository uses: actions/checkout@master - - name: Use Node.js ${{ matrix.node-version }} - uses: actions/setup-node@v1 + - name: Set up Node.js + uses: actions/setup-node@master with: - node-version: ${{ matrix.node-version }} + node-version: 10.0.0 - name: Publish if version has been updated uses: pascalgn/npm-publish-action@4f4bf159e299f65d21cd1cbd96fc5d53228036df with: # All of theses inputs are optional From 69a2fcddef57410fce74be1d96ff37a88b820d66 Mon Sep 17 00:00:00 2001 From: Bassem Dghaidi Date: Fri, 1 May 2020 20:20:46 +0200 Subject: [PATCH 2/5] Update README to include reference to REALEASE manual --- README.md | 4 ++++ RELEASE.md | 28 ++++++++++++++++++++++++++++ 2 files changed, 32 insertions(+) create mode 100644 RELEASE.md diff --git a/README.md b/README.md index e8ba774..25033df 100644 --- a/README.md +++ b/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) diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000..1ff6e1e --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,28 @@ +# 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` +- [ ] Capture all the changes / commits in a feature branch +- [ ] Rebase all changes from upstream to your local master branch +- [ ] Rebase feature branch with the master branch +- [ ] Tag the release with the following format: `MAJOR.MINOR.PATCH` +- [ ] Push the commits in the master branch and tags upstream +- [ ] In GitHub actions verify that the new tag passes the `Build & Test` workflow +- [ ] In GitHub create a release from the recently pushed tag +- [ ] 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 From cdcb20f53f39b2ca14229408682acb80b2de3922 Mon Sep 17 00:00:00 2001 From: Bassem Dghaidi Date: Fri, 1 May 2020 20:22:50 +0200 Subject: [PATCH 3/5] Add develop branch to the list of build trigger branches --- .github/workflows/build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 3eacfe7..578ee26 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -5,7 +5,7 @@ name: Build & Test on: push: - branches: [ master ] + branches: [ master, develop ] pull_request: branches: [ master ] From e49d9156dd65c357a18c42a572e46075d74b4a8d Mon Sep 17 00:00:00 2001 From: Bassem Dghaidi Date: Fri, 1 May 2020 20:31:48 +0200 Subject: [PATCH 4/5] Update release checklist --- RELEASE.md | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 1ff6e1e..ec3f039 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -17,12 +17,13 @@ Reference: https://semver.org/ Make sure you cover all the steps below for a new version release. - [ ] Update the release version number in `package.json` -- [ ] Capture all the changes / commits in a feature branch -- [ ] Rebase all changes from upstream to your local master branch -- [ ] Rebase feature branch with the master branch -- [ ] Tag the release with the following format: `MAJOR.MINOR.PATCH` -- [ ] Push the commits in the master branch and tags upstream -- [ ] In GitHub actions verify that the new tag passes the `Build & Test` workflow -- [ ] In GitHub create a release from the recently pushed tag +- [ ] 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 From 260b1d39e277127a3b8deaa26e17772b2ec6c687 Mon Sep 17 00:00:00 2001 From: Bassem Dghaidi Date: Fri, 1 May 2020 20:33:16 +0200 Subject: [PATCH 5/5] Update version to 0.1.9 --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 666a8f6..859020d 100644 --- a/package.json +++ b/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": {