feat(ci): add automated release (#116)

.github/workflows/pull-request.yml

@@ -45,3 +45,18 @@ jobs:
         with:
           token: ${{ secrets.CODECOV_TOKEN }}
         continue-on-error: true
+
+  commitlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: wagoid/commitlint-github-action@v2
+
+  prlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/[email protected]
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,3 +1,4 @@
+.envrc
 *-debug.log
 *-error.log
 /.nyc_output

PUBLISHING.md

@@ -2,24 +2,22 @@
 
 Here are the steps to publish a version
 
-## Update local repository with the latest version of the master branch
+## Prerequisites
 
-```sh
-$ git fetch -pPt --all
-$ git checkout master
-$ git pull origin master
-```
+1. Create a [github personal token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)
+2. Set the CONVENTIONAL_GITHUB_RELEASER_TOKEN environment variable with the github personal token value (you can use [direnv](https://direnv.net/))
 
-## Create the new version
-
-_This will create a new tag and new draft release on github_
+## Create a new Release
 
 ```sh
-$ yarn version --major|--minor|--patch --message '<Release Title>'
-$ git push -f origin master --tags
+$ yarn release
 ```
 
-Go to gihub and finish the new release
-Fill the name (select the tag created by `yarn version` <vX.X.X>)
-Fill the title with the tag message value (<Release Title>)
-Fill the release body following [keep a changelog](https://keepachangelog.com/en/1.0.0/) best practices
+It will :
+
+- Create a new version based on the commit types from head and package.json version
+- Create the changelog with all the commit from head and the last tag version following [keepachangelog](https://keepachangelog.com/en/1.0.0/)
+- Create a new commit with the generated changelog, update package.json
+- Create a new tag following the semver
+- Push this tag to the remote
+- Trigger the new version publish

commitlint.config.js

@@ -0,0 +1 @@
+module.exports = { extends: ['@commitlint/config-angular'] }

package.json

@@ -29,6 +29,7 @@
   },
   "husky": {
     "hooks": {
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
       "pre-commit": "lint-staged && yarn analysis",
       "pre-push": "yarn test:coverage"
     }
@@ -64,25 +65,33 @@
   },
   "homepage": "https://github.com/scolladon/sfdx-git-delta#readme",
   "scripts": {
+    "analysis": "codeclimate analyze",
+    "commit": "commit",
+    "lint": "eslint . ; tslint --project . --config tslint.json --format stylish",
+    "lint:fix": "eslint --fix . ; tslint --fix --project . --config tslint.json --format stylish",
     "test": "jest --runInBand",
-    "test:debug": "node --inspect node_modules/.bin/jest --runInBand",
-    "test:coverage": "jest --coverage --runInBand",
     "test:clear:cache": "jest --clearCache",
-    "lint:fix": "eslint --fix . ; tslint --fix --project . --config tslint.json --format stylish",
-    "lint": "eslint . ; tslint --project . --config tslint.json --format stylish",
-    "analysis": "codeclimate analyze",
+    "test:coverage": "jest --coverage --runInBand",
+    "test:debug": "node --inspect node_modules/.bin/jest --runInBand",
     "postpack": "rm -f oclif.manifest.json",
+    "postrelease": "npm run release:tags && npm run release:github",
     "prepack": "rm -rf lib && tsc -b && oclif-dev manifest && oclif-dev readme",
-    "version": "oclif-dev readme && git add README.md"
+    "release": "standard-version",
+    "release:github": "conventional-github-releaser -p angular",
+    "release:tags": "git push --follow-tags origin master"
   },
   "devDependencies": {
+    "@commitlint/cli": "^12.0.1",
+    "@commitlint/config-angular": "^12.0.1",
+    "@commitlint/prompt-cli": "^12.0.1",
     "@oclif/dev-cli": "^1",
     "@oclif/plugin-help": "^2",
     "@oclif/test": "^1",
     "@salesforce/dev-config": "1.4.1",
     "@types/chai": "^4",
     "@types/mocha": "^5",
     "@types/node": "^10",
+    "conventional-github-releaser": "^3.1.5",
     "eslint": "^7.10.0",
     "eslint-config-prettier": "^6.12.0",
     "eslint-plugin-prettier": "^3.1.4",
@@ -93,6 +102,7 @@
     "nyc": "^14",
     "prettier": "^2.1.2",
     "prettier-eslint": "^11.0.0",
+    "standard-version": "^9.1.1",
     "ts-node": "^8",
     "typescript": "^4.0.5"
   },
@@ -106,4 +116,4 @@
   "publishConfig": {
     "access": "public"
   }
-}
+}