ci(template): update project template from ahmadnassri/template-node-lib

.github/dependabot.yml

@@ -11,4 +11,3 @@ updates:
     directory: /
     schedule:
       interval: daily
-

.github/workflows/auto-merge.yml

@@ -10,4 +10,4 @@ jobs:
     steps:
       - uses: ahmadnassri/action-dependabot-auto-merge@v1
         with:
-          github-token: ${{ secrets.GH_TOKEN }}
+          github-token: ${{ secrets.GH_TOKEN || secrets.GITHUB_TOKEN }}

.github/workflows/release.yml

@@ -6,18 +6,16 @@ on:
       - master
 
 jobs:
-  dependencies:
+  audit:
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v2
       - uses: actions/[email protected]
-
-      # run checks
       - run: npm audit --audit-level=moderate
 
   test:
-    needs: dependencies
+    needs: audit
 
     strategy:
       matrix:
@@ -28,17 +26,15 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-
       - uses: actions/cache@v2
         with:
           path: ~/.npm
-          key: client-${{ hashFiles('**/package-lock.json') }}
+          key: ${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
 
       - uses: actions/[email protected]
         with:
           node-version: ${{ matrix.node-version }}
 
-      # run test
       - run: npm ci
       - run: npm run test
 
@@ -49,9 +45,7 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-
-      - name: semantic-release
-        uses: ahmadnassri/action-semantic-release@v1
+      - uses: ahmadnassri/action-semantic-release@v1
         env:
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN || secrets.GITHUB_TOKEN }}

.github/workflows/super-linter.yml

@@ -11,4 +11,4 @@ jobs:
       - uses: docker://github/super-linter:v3
         env:
           VALIDATE_ALL_CODEBASE: false
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GH_TOKEN || secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -6,18 +6,16 @@ on:
       - master
 
 jobs:
-  dependencies:
+  audit:
     runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v2
       - uses: actions/[email protected]
-
-      # run checks
       - run: npm audit --audit-level=moderate
 
   test:
-    needs: dependencies
+    needs: audit
 
     strategy:
       matrix:
@@ -28,16 +26,14 @@ jobs:
 
     steps:
       - uses: actions/checkout@v2
-
       - uses: actions/cache@v2
         with:
           path: ~/.npm
-          key: client-${{ hashFiles('**/package-lock.json') }}
+          key: ${{ matrix.node-version }}-${{ hashFiles('**/package-lock.json') }}
 
       - uses: actions/[email protected]
         with:
           node-version: ${{ matrix.node-version }}
 
-      # run test
       - run: npm ci
       - run: npm run test

colophon.yml

@@ -0,0 +1,8 @@
+version: 2.0
+
+id: oas-request
+
+about:
+  title: OpenAPI Spec HTTP Client
+  description: Feed it a JSON Spec, it will spit out a lightweight HTTP client!
+  repository: ahmadnassri/node-oas-request

docker-compose.yml

@@ -22,12 +22,11 @@ services:
     image: pandoc/core
     volumes:
       - ./:/data
-    command: docs/README.md --template docs/README.template --output README.md --from markdown_github+yaml_metadata_block --to gfm --fail-if-warnings
+    command: docs/README.md --metadata-file colophon.yml --template docs/README.template --output README.md --from markdown_github+yaml_metadata_block --to gfm --fail-if-warnings
 
   test:
     <<: *node
     image: node:alpine
-    # command: npm run test:coverage
     depends_on:
       - node10
       - node12

docs/README.md

@@ -1,10 +1,3 @@
----
-title: OpenAPI Spec HTTP Client
-description: Feed it a JSON Spec, it will spit out a lightweight HTTP client!
-repo: ahmadnassri/node-oas-request
-package: oas-request
----
-
 ## Why
 
 While there are plenty of _"code generators"_ for OpenAPI, they create a lot of "garbage" code that you may not need,

docs/README.template

@@ -1,6 +1,6 @@
-# $title$
+# $about.title$
 
-$description$
+$about.description$
 
 [![license][license-img]][license-url]
 [![version][npm-img]][npm-url]
@@ -15,16 +15,16 @@ $body$
 > Twitter: [@AhmadNassri](https://twitter.com/AhmadNassri)
 
 [license-url]: LICENSE
-[license-img]: https://badgen.net/github/license/$repo$
+[license-img]: https://badgen.net/github/license/$about.repository$
 
-[npm-url]: https://www.npmjs.com/package/$package$
-[npm-img]: https://badgen.net/npm/v/$package$
+[npm-url]: https://www.npmjs.com/package/$id$
+[npm-img]: https://badgen.net/npm/v/$id$
 
-[super-linter-url]: https://github.com/$repo$/actions?query=workflow%3Asuper-linter
-[super-linter-img]: https://github.com/$repo$/workflows/super-linter/badge.svg
+[super-linter-url]: https://github.com/$about.repository$/actions?query=workflow%3Asuper-linter
+[super-linter-img]: https://github.com/$about.repository$/workflows/super-linter/badge.svg
 
-[test-url]: https://github.com/$repo$/actions?query=workflow%3Atest
-[test-img]: https://github.com/$repo$/workflows/test/badge.svg
+[test-url]: https://github.com/$about.repository$/actions?query=workflow%3Atest
+[test-img]: https://github.com/$about.repository$/workflows/test/badge.svg
 
-[release-url]: https://github.com/$repo$/actions?query=workflow%3Arelease
-[release-img]: https://github.com/$repo$/workflows/release/badge.svg
+[release-url]: https://github.com/$about.repository$/actions?query=workflow%3Arelease
+[release-img]: https://github.com/$about.repository$/workflows/release/badge.svg

package.json

@@ -1,7 +1,7 @@
 {
   "version": "0.0.0-semantically-released",
   "name": "oas-request",
-  "description": "OAS 3.x dynamic request client",
+  "description": "Feed it a JSON Spec, it will spit out a lightweight HTTP client!",
   "author": "Ahmad Nassri <[email protected]> (https://www.ahmadnassri.com)",
   "homepage": "https://github.com/ahmadnassri/node-oas-request",
   "repository": {
@@ -30,6 +30,5 @@
   "devDependencies": {
     "sinon": "^9.0.2",
     "tap": "^14.10.8"
-  },
-  "dependencies": {}
+  }
 }