Add publishing workflow; update workflow, dependencies, tasks, docs

.github/workflows/publish.yml

@@ -0,0 +1,37 @@
+on:
+  release:
+    types: [created, edited, published]
+  workflow_dispatch:
+    inputs:
+      dryRun:
+        description: 'Dry run only'
+        required: true
+        default: true
+        type: boolean
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 12
+          registry-url: 'https://registry.npmjs.org'
+      - run: npm ci
+
+      - name: Publish package
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.REGISTRY_PUBLISH_TOKEN }}
+        if: >
+          (github.event_name == 'release' && github.event.action == 'published') ||
+          (github.event_name == 'workflow_dispatch' && !inputs.dryRun)
+        run: npm publish
+
+      - name: Publish package (dry run)
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.REGISTRY_PUBLISH_TOKEN }}
+        if: >
+          (github.event_name == 'release' && github.event.action != 'published') ||
+          (github.event_name == 'workflow_dispatch' && inputs.dryRun)
+        run: npm publish --dry-run

.github/workflows/tests.yml

@@ -1,45 +1,32 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests.
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: Build and lint
-
 on:
   push:
     branches:
       - main
   pull_request:
 
 jobs:
-  checkout_and_test:
+  test:
     runs-on: ubuntu-20.04
     strategy:
       matrix:
-        include:
-          - node-version: 12.x
-            lint: true # Linter is run only once to shorten the total build time
-          - node-version: 14.x
-          - node-version: 16.x
-
+        node-version: [12, 14, 16]
     steps:
-      - name: Checkout code from ${{ github.repository }}
-        uses: actions/checkout@v4
-      - name: Setup node
-        uses: actions/setup-node@v3
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node-version }}
-      - name: MongoDB in GitHub Actions
+      - run: npm ci
+      - run: make lint
+      - run: make test-unit
+
+      - name: Supply MongoDB 3.4
         uses: supercharge/[email protected]
         with:
-          mongodb-version: 3.4
-      - name: Install dependencies
-        run: npm ci
-      - name: Run linter
-        if: ${{ matrix.lint }}
-        run: make lint
-      - name: Create test config
+          mongodb-version: 3.4      
+      - name: Supply integration test configuration file
         run: cp config/test.sample.json config/test.json
-      - name: Start test app
+      - name: Make webservice available to be integration-tested
         run: NODE_ENV=test node index.js &
       - run: sleep 10s
-      - name: Run tests
-        run: make test
+
+      - run: make test-integration

Makefile

@@ -1,17 +1,6 @@
 include Makefile.node
 
-
-# Verify tasks
-# ------------
-
-# Lint alias for backwards compatibility
-lint: verify
-
-
-# Database tasks
-# --------------
-
-# Add fixtures
+# Add fixtures to database
 fixtures:
 	@node ./script/fixtures.js
 	@$(TASK_DONE)

Makefile.node

@@ -1,28 +1,13 @@
-#
-# Node.js Makefile
-# ================
-#
-# Do not update this file manually – it's maintained separately on GitHub:
-# https://github.com/rowanmanning/makefiles/blob/master/Makefile.node
-#
-# To update to the latest version, run `make update-makefile`.
-#
-
-
-# Meta tasks
-# ----------
+# Ignore presence of folder `test`
+# --------------------------------
 
 .PHONY: test
 
 
-# Useful variables
-# ----------------
+# Make deps available
+# -------------------
 
-NPM_BIN = ./node_modules/.bin
-export PATH := $(NPM_BIN):$(PATH)
-export EXPECTED_COVERAGE := 90
-export INTEGRATION_TIMEOUT := 5000
-export INTEGRATION_SLOW := 4000
+export PATH := ./node_modules/.bin:$(PATH)
 
 
 # Output helpers
@@ -31,95 +16,17 @@ export INTEGRATION_SLOW := 4000
 TASK_DONE = echo "✓ $@ done"
 
 
-# Group tasks
-# -----------
-
-all: install ci
-ci: verify test
-
-
-# Install tasks
-# -------------
-
-clean:
-	@git clean -fxd
-	@$(TASK_DONE)
-
-install: node_modules
-	@$(TASK_DONE)
-
-node_modules: package.json
-	@npm prune --production=false
-	@npm install
-	@$(TASK_DONE)
-
-
-# Verify tasks
-# ------------
-
-verify: verify-javascript verify-dust verify-spaces
-	@$(TASK_DONE)
-
-verify-javascript: verify-eslint verify-jshint verify-jscs
-	@$(TASK_DONE)
-
-verify-dust:
-	@if [ -e .dustmiterc* ]; then dustmite --path ./view && $(TASK_DONE); fi
-
-verify-eslint:
-	@if [ -e .eslintrc* ]; then eslint . && $(TASK_DONE); fi
-
-verify-jshint:
-	@if [ -e .jshintrc* ]; then jshint . && $(TASK_DONE); fi
-
-verify-jscs:
-	@if [ -e .jscsrc* ]; then jscs . && $(TASK_DONE); fi
+# Linting and testing
+# -------------------
 
-verify-spaces:
-	@if [ -e .editorconfig* ] && [ -x $(NPM_BIN)/lintspaces ]; then \
-		git ls-files | xargs lintspaces -e .editorconfig && $(TASK_DONE); \
-	fi
+lint:
+	@eslint . && $(TASK_DONE)
 
-verify-coverage:
-	@if [ -d coverage ]; then \
-		if [ -x $(NPM_BIN)/nyc ]; then \
-			nyc check-coverage --lines $(EXPECTED_COVERAGE) --functions $(EXPECTED_COVERAGE) --branches $(EXPECTED_COVERAGE) && $(TASK_DONE); \
-		else \
-			if [ -x $(NPM_BIN)/istanbul ]; then \
-				istanbul check-coverage --statement $(EXPECTED_COVERAGE) --branch $(EXPECTED_COVERAGE) --function $(EXPECTED_COVERAGE) && $(TASK_DONE); \
-			fi \
-		fi \
-	fi
-
-# Test tasks
-# ----------
-
-test: test-unit-coverage verify-coverage test-integration
+test: test-unit test-integration
 	@$(TASK_DONE)
 
 test-unit:
-	@if [ -d test/unit ]; then mocha test/unit --exit --recursive && $(TASK_DONE); fi
-
-test-unit-coverage:
-	@if [ -d test/unit ]; then \
-		if [ -x $(NPM_BIN)/nyc ]; then \
-			nyc --reporter=text --reporter=html $(NPM_BIN)/_mocha test/unit --exit --recursive && $(TASK_DONE); \
-		else \
-			if [ -x $(NPM_BIN)/istanbul ]; then \
-				istanbul cover $(NPM_BIN)/_mocha -- test/unit --exit --recursive && $(TASK_DONE); \
-			else \
-				make test-unit; \
-			fi \
-		fi \
-	fi
+	@mocha test/unit --exit --recursive && $(TASK_DONE)
 
 test-integration:
-	@if [ -d test/integration ]; then mocha test/integration --exit --timeout $(INTEGRATION_TIMEOUT) --slow $(INTEGRATION_SLOW) && $(TASK_DONE); fi
-
-
-# Tooling tasks
-# -------------
-
-update-makefile:
-	@curl -s https://raw.githubusercontent.com/rowanmanning/makefiles/master/Makefile.node > Makefile.node
-	@$(TASK_DONE)
+	@mocha test/integration --exit --timeout 20000 --slow 4000 && $(TASK_DONE)