chore(template): update template to match ahmadnassri/template-node-lib

.editorconfig

@@ -1,3 +1,7 @@
+# ----------------------------------------------------------- #
+# Note: this file originates in ahmadnassri/template-template #
+# ----------------------------------------------------------- #
+
 root = true
 
 [*]
@@ -10,3 +14,6 @@ trim_trailing_whitespace = true
 
 [*.md]
 trim_trailing_whitespace = false
+
+[Makefile]
+indent_style = tab

.github/auto-merge.yml

@@ -0,0 +1,15 @@
+# ----------------------------------------------------------- #
+# Note: this file originates in ahmadnassri/template-template #
+# ----------------------------------------------------------- #
+
+- match:
+    dependency_type: development
+    update_type: semver:minor
+
+- match:
+    dependency_type: production
+    update_type: security:minor
+
+- match:
+    dependency_type: production
+    update_type: semver:patch

.github/dependabot.yml

@@ -1,14 +1,45 @@
+# ----------------------------------------------------------- #
+# Note: this file originates in ahmadnassri/template-template #
+# ----------------------------------------------------------- #
+
 version: 2
 updates:
+  - package-ecosystem: gitsubmodule
+    open-pull-requests-limit: 10
+    directory: /
+    commit-message:
+      prefix: build
+      prefix-development: chore
+      include: scope
+    schedule:
+      interval: daily
+
   - package-ecosystem: github-actions
     open-pull-requests-limit: 10
     directory: /
+    commit-message:
+      prefix: chore
+      prefix-development: chore
+      include: scope
     schedule:
       interval: daily
 
   - package-ecosystem: npm
     open-pull-requests-limit: 10
     directory: /
+    commit-message:
+      prefix: build
+      prefix-development: chore
+      include: scope
     schedule:
       interval: daily
 
+  - package-ecosystem: docker
+    open-pull-requests-limit: 10
+    directory: /
+    commit-message:
+      prefix: build
+      prefix-development: chore
+      include: scope
+    schedule:
+      interval: daily

.github/linters/.commit-lint.yml

@@ -0,0 +1,8 @@
+# ----------------------------------------------------------- #
+# Note: this file originates in ahmadnassri/template-template #
+# ----------------------------------------------------------- #
+
+extends:
+  - "@commitlint/config-conventional"
+rules:
+  body-max-line-length: [2, 'always', 200]

.github/linters/.markdown-lint.yml

@@ -1,3 +1,7 @@
+# ----------------------------------------------------------- #
+# Note: this file originates in ahmadnassri/template-template #
+# ----------------------------------------------------------- #
+
 # Heading levels should only increment by one level at a time
 MD001: false
 
@@ -101,7 +105,7 @@ MD032: true
 
 # inline HTML
 MD033:
-  allowed_elements: []
+  allowed_elements: [details, summary]
 
 # Bare URL used
 MD034: true
@@ -127,7 +131,7 @@ MD039: true
 MD040: true
 
 # First line in file should be a top level heading
-MD041: true
+MD041: false
 
 # No empty links
 MD042: true

.github/matrix.json

@@ -0,0 +1,4 @@
+{
+  "os": ["ubuntu-latest", "windows-latest", "macos-latest"],
+  "node-version": [12, 14, 15]
+}

.github/workflows/auto-merge.yml

@@ -1,13 +1,19 @@
+# ----------------------------------------------------------- #
+# Note: this file originates in ahmadnassri/template-template #
+# ----------------------------------------------------------- #
+
 name: auto-merge
 
-on:
-  pull_request:
+on: pull_request
 
 jobs:
   auto-merge:
+    timeout-minutes: 5
+
     runs-on: ubuntu-latest
-    if: github.actor == 'dependabot[bot]'
+
     steps:
-      - uses: ahmadnassri/[email protected]
+      - uses: actions/checkout@v2
+      - uses: ahmadnassri/action-dependabot-auto-merge@v2
         with:
           github-token: ${{ secrets.GH_TOKEN }}

.github/workflows/commit-lint.yml

@@ -0,0 +1,32 @@
+# ----------------------------------------------------------- #
+# Note: this file originates in ahmadnassri/template-template #
+# ----------------------------------------------------------- #
+
+name: commit-lint
+
+on: [push, pull_request]
+
+jobs:
+  deduplicate:
+    timeout-minutes: 5
+
+    runs-on: ubuntu-latest
+
+    # run on external PRs, but not on our internal PRs
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+
+    steps:
+      - run: echo ::info ::de-duplicate ran successfully
+
+  commit-lint:
+    timeout-minutes: 5
+
+    needs: deduplicate
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ahmadnassri/action-commit-lint@v1
+        with:
+          config: .github/linters/.commit-lint.yml

.github/workflows/readme.yml

@@ -0,0 +1,54 @@
+# ----------------------------------------------------------- #
+# Note: this file originates in ahmadnassri/template-template #
+# ----------------------------------------------------------- #
+
+name: readme
+
+on:
+  push:
+    branches: master
+    paths:
+      - docs/**
+      - colophon.yml
+      - .github/workflows/readme.yml
+
+jobs:
+  readme:
+    timeout-minutes: 5
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: docker://pandoc/core:2.11.4
+        with:
+          args: >-
+            --metadata-file=colophon.yml
+            --template=docs/README.template
+            --output=README.md
+            --from=gfm
+            --to=gfm
+            --fail-if-warnings
+            --wrap=preserve
+            --reference-links
+            docs/README.md
+
+      - uses: actions/github-script@v3
+        with:
+          github-token: ${{secrets.GH_TOKEN}}
+          script: |
+            const { readFileSync } = require('fs')
+
+            const path = 'README.md'
+
+            const content = readFileSync(`${process.env.GITHUB_WORKSPACE}/${path}`)
+
+            const { data } = await github.repos.getContent({ ...context.repo, path })
+
+            if (Buffer.from(data.content, 'base64').compare(content) === 0) return
+
+            await github.repos.createOrUpdateFileContents({...context.repo, path,
+              sha: data.sha,
+              message: 'docs(readme): update readme',
+              content: content.toString('base64')
+            })

.github/workflows/release.yml

@@ -1,57 +1,61 @@
+# ----------------------------------------------------------- #
+# Note: this file originates in ahmadnassri/template-node-lib #
+# ----------------------------------------------------------- #
+
 name: release
 
 on:
-  push:
-    branches:
-      - master
+  workflow_run:
+    workflows: [ test ]
+    branches: [ master ]
+    types: [ completed ]
 
 jobs:
-  dependencies:
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/[email protected]
-
-      # run checks
-      - run: npm audit --audit-level=moderate
+  release:
+    timeout-minutes: 5
 
-  test:
-    needs: dependencies
+    runs-on: ubuntu-latest
 
-    strategy:
-      matrix:
-        os: [ubuntu-latest, windows-latest, macos-latest]
-        node-version: [10, 12, 13, 14]
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
 
-    runs-on: ${{ matrix.os }}
+    outputs:
+      published: ${{ steps.release.outputs.published }}
+      version: ${{ steps.release.outputs.release-version }}
 
     steps:
       - uses: actions/checkout@v2
-
-      - uses: actions/[email protected]
         with:
-          path: ~/.npm
-          key: client-${{ hashFiles('**/package-lock.json') }}
+          submodules: true
 
-      - uses: actions/[email protected]
+      - id: release
+        uses: ahmadnassri/action-semantic-release@v1
         with:
-          node-version: ${{ matrix.node-version }}
+          config: ${{ github.workspace }}/.semantic.json
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
 
-      # run test
-      - run: npm ci
-      - run: npm run test
+  mirror:
+    needs: release
 
-  release:
-    needs: test
+    timeout-minutes: 5
 
     runs-on: ubuntu-latest
 
+    if: needs.release.outputs.published == 'true'
+
     steps:
       - uses: actions/checkout@v2
+        with:
+          submodules: true
 
-      - name: semantic-release
-        uses: ahmadnassri/action-semantic-release@v1
-        env:
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - uses: ahmadnassri/action-github-registry-npm-proxy@v1
+        with:
+          github-token: ${{ secrets.GH_TOKEN }}
+          owner: ${{ github.repository_owner }}
+
+      - name: publish to github registry
+        run: |
+          jq '.name = "@'${GITHUB_REPOSITORY/node-/}'"' package.json > /tmp/package.json; mv /tmp/package.json .
+          npm version --no-git-tag-version v${{ needs.release.outputs.version }}
+          npm publish

.github/workflows/super-linter.yml

@@ -1,14 +1,34 @@
+# ----------------------------------------------------------- #
+# Note: this file originates in ahmadnassri/template-template #
+# ----------------------------------------------------------- #
+
 name: super-linter
 
-on: push
+on: [ push, pull_request ]
 
 jobs:
-  super-linter:
+  deduplicate:
+    timeout-minutes: 5
+
+    runs-on: ubuntu-latest
+
+    # run on external PRs, but on internal PRs as they'll be run by the push to the branch.
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+
+    steps:
+      - run: echo ::info ::de-duplicate ran successfully
+
+  lint:
+    timeout-minutes: 5
+
+    needs: deduplicate
+
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v2
-      - uses: docker://github/super-linter:v3
+      - uses: github/super-linter@v3.15.1
         env:
+          LOG_LEVEL: ERROR
           VALIDATE_ALL_CODEBASE: false
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ github.token }}