ci: add commitlint job (#209)

- migrate from circle to github actions
- make repo commitizen friendly
- drop node 10 support

Author: john-u

.circleci/config.yml

@@ -40,12 +40,6 @@ jobs:
       - codecov/upload:
           file: coverage/*.json
       - *persist_to_workspace
-  publish:
-    executor: daneel
-    steps:
-      - *attach_workspace
-      - checkout
-      - run: npm run semantic-release
 
 workflows:
   build:
@@ -54,10 +48,3 @@ workflows:
           filters:
             branches:
               only: /.*/
-      - publish:
-          context: pi
-          requires:
-            - build
-          filters:
-            branches:
-              only: master

.commitlintrc.yml

@@ -0,0 +1,4 @@
+extends:
+  - "@commitlint/config-conventional"
+rules:
+  body-max-line-length: [1, "always", 100]

.czrc

@@ -0,0 +1,3 @@
+{
+  "path": "cz-conventional-changelog"
+}

.github/workflows/ci-cd.yml

@@ -0,0 +1,70 @@
+name: CI/CD
+
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+    branches:
+      - master
+
+jobs:
+  lint-commits:
+    if: github.event_name == 'pull_request'
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v2
+        with:
+          node-version: 14
+          cache: "npm"
+      - run: npm ci --ignore-scripts
+      - run: npx commitlint --from HEAD~${{ github.event.pull_request.commits }} --to HEAD
+
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        # add/remove versions as we move support forward
+        node-version: [12, 14, 16]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: "npm"
+      - run: npm ci
+      - run: npm run lint
+      - run: npm run test:unit
+
+  release:
+    needs: build
+
+    # don't run on forks
+    if: ${{ github.repository_owner == 'SmartThingsCommunity' && github.ref == 'refs/heads/master' }}
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: 14
+          cache: "npm"
+      - run: npm ci
+      - name: Release
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.PI_GITHUB_TOKEN }}
+          GIT_AUTHOR_NAME: smartthingspi
+          GIT_AUTHOR_EMAIL: pi-team@smartthings.com
+          GIT_COMMITTER_NAME: smartthingspi
+          GIT_COMMITTER_EMAIL: pi-team@smartthings.com
+        run: npx semantic-release

.releaserc.yml

@@ -0,0 +1,11 @@
+plugins:
+  - "@semantic-release/commit-analyzer"
+  - "@semantic-release/release-notes-generator"
+  - "@semantic-release/github"
+  - - "@semantic-release/changelog"
+    - changelogFile: docs/CHANGELOG.md
+  - "@semantic-release/npm"
+  - - "@semantic-release/git"
+    - assets: ["docs", "package.json"]
+      message: "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
+preset: conventionalcommits

.sgcrc

@@ -1,5 +1,7 @@
 {
 	"cSpell.words": [
+		"commitlint",
+		"conventionalcommits",
 		"hideable"
 	]
 }

.vscode/settings.json

@@ -30,14 +30,12 @@ We're always looking for more opinions on discussions in the issue tracker. It's
   - Use a clear and descriptive title for the pull request and commits
   - We use [semantic-release](https://www.npmjs.com/package/semantic-release) to automatically generate release
     notes, versions and publish releases. This requires commit messages must be formatted properly using
-    [Angular's git commit guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines).
-  - As a convenience, a tool called `semantic-git-commit-cli` is installed in node_modules so you can commit using
-    `npx sgc` instead of `git commit`. This tool will ask a series of questions and generate a properly-formatted
-    commit message for you. You can still run `git commit` and format the message properly yourself if you prefer.
+    [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/). Our CI will check this and fail any PRs that are formatted incorrectly.
+  - This repo is [commitizen friendly](https://github.com/commitizen/cz-cli), so you can use the `cz` cli to help create your commits.
 - Lint and test before submitting the pull request by running `$ npm test`
 - Write a convincing description of why we should land your pull request. Answer _why_ it's needed and provide use-cases.
 - Make the pull request from a [topic branch](https://github.com/dchelimsky/rspec/wiki/Topic-Branches) (not master)
-- You might be asked to do changes to your pull request. There's never a need to open another pull request – [just update the existing one.](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md)
+- You might be asked to do changes to your pull request. There's never a need to open another pull request – [just update the existing one.](https://github.com/RichardLitt/knowledge/blob/master/github/amending-a-commit-guide.md)
 
 ## [Finding contributions to work on](labels/help%20wanted)
 

CONTRIBUTING.md

@@ -3,7 +3,6 @@
 <p align="center">
 <a href="https://www.npmjs.com/package/@smartthings/smartapp"><img src="https://badgen.net/npm/v/@smartthings/smartapp"/></a>
 <a href="https://www.npmjs.com/package/@smartthings/smartapp"><img src="https://badgen.net/npm/license/@smartthings/smartapp"/></a>
-<a href="https://circleci.com/gh/SmartThingsCommunity/smartapp-sdk-nodejs/tree/master"><img src="https://circleci.com/gh/SmartThingsCommunity/smartapp-sdk-nodejs.svg?style=svg"/></a>
 <a href="https://codecov.io/gh/SmartThingsCommunity/smartapp-sdk-nodejs"><img src="https://codecov.io/gh/SmartThingsCommunity/smartapp-sdk-nodejs/branch/master/graph/badge.svg"/></a>
 <a href="https://status.badgen.net/"><img src="https://badgen.net/xo/status/@smartthings/smartapp"/></a>
 <a href="https://lgtm.com/projects/g/SmartThingsCommunity/smartapp-sdk-nodejs/context:javascript"><img alt="Language grade: JavaScript" src="https://img.shields.io/lgtm/grade/javascript/g/SmartThingsCommunity/smartapp-sdk-nodejs.svg?logo=lgtm&logoWidth=18"/></a>