GDL-9 publish npm package to registry

Author: tcarmet

.github/workflows/release.yaml

@@ -0,0 +1,74 @@
+---
+name: Release
+
+run-name: release ${{ inputs.tag }}
+
+on:
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Tag to be released'
+        required: true
+
+permissions:
+  packages: write
+  id-token: write
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Ensure the branch is protected
+        run: |
+          if [[ "${{ github.ref_protected }}" == "false" ]]; then
+            echo "::error::The branch ${{ github.ref }} is not protected"
+            exit 1
+          fi
+      - name: Ensure tag has not been released
+        run: |
+          TAG_EXISTS=$(git tag -l "${{ inputs.tag }}")
+          if [ -n "$TAG_EXISTS" ]; then
+            echo "::error::The tag ${{ inputs.tag }} has already been released"
+            exit 1
+          fi
+      - name: Ensure version is properly set
+        run: |
+           PKG_VERSION="$(yarn -s run get-version)"
+           if ! [ "$PKG_VERSION" = "$VERSION" ]; then
+             echo "::error file=package.json,line=$(sed -n '/"version":/=' package.json)::The tag $VERSION must match the version $PKG_VERSION specified in package.json"
+             exit 1
+           fi
+        env:
+          VERSION: ${{ inputs.tag }}
+      - name: Setup node with GitHub Packages
+        uses: actions/setup-node@v4
+        with:
+          cache: yarn
+          node-version: '16'
+          registry-url: https://npm.pkg.github.com
+      - run: yarn install --frozen-lockfile
+      - name: Publish to GitHub Packages
+        run: npm publish --provenance
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Setup node with npmjs.org
+        uses: actions/setup-node@v4
+        with:
+          node-version: '16'
+          registry-url: https://registry.npmjs.org
+      - name: Publish to npmjs.org
+        run: npm publish --provenance
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - name: Create Release
+        uses: softprops/action-gh-release@v2
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ inputs.tag }}
+          name: Release ${{ inputs.tag }}
+          target_commitish: ${{ github.sha }}

.github/workflows/tests.yaml

@@ -6,18 +6,30 @@ on:
     branches-ignore:
     - 'development/**'
 
+permissions:
+  packages: write
+  id-token: write
+  contents: read
+
 jobs:
   test:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
-    - uses: actions/setup-node@v2
+      uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
       with:
         node-version: '16'
+        registry-url: https://npm.pkg.github.com
     - name: install dependencies
       run: yarn install --frozen-lockfile
     - name: lint markdown
       run: yarn lint_md
     - name: lint javascript
       run: yarn lint
+    - name: Set development version
+      run: yarn version --no-git-tag-version --new-version "0.0.0-sha.${{ github.sha }}"
+    - name: Publish development version
+      run: npm publish --provenance
+      env:
+        NODE_AUTH_TOKEN: ${{ github.token }}

.npmignore

@@ -0,0 +1,6 @@
+*
+!LICENSE
+!bin/
+!index.js
+!package.json
+!README.md

package.json

@@ -1,19 +1,20 @@
 {
-    "name": "eslint-config-scality",
+    "name": "@scality/eslint-config",
     "version": "7.10.2",
     "description": "ESLint config for Scality's Node.js coding guidelines",
     "bin": {
-        "mdlint": "./bin/mdlint.js"
+        "mdlint": "bin/mdlint.js"
     },
     "main": "index.js",
     "scripts": {
         "test": "npm run --silent lint && npm run --silent lint_md",
-        "lint": "node_modules/.bin/eslint -c index.js $(git ls-files '*.js')",
-        "lint_md": "node bin/mdlint.js $(git ls-files '*.md')"
+        "lint": "eslint -c index.js $(git ls-files '*.js')",
+        "lint_md": "node bin/mdlint.js $(git ls-files '*.md')",
+        "get-version": "echo $npm_package_version"
     },
     "repository": {
         "type": "git",
-        "url": "https://github.com/scality/Guidelines"
+        "url": "git+https://github.com/scality/Guidelines.git"
     },
     "dependencies": {
         "commander": "1.3.2",
@@ -39,5 +40,8 @@
     "homepage": "https://github.com/scality/Guidelines",
     "engines": {
         "node": ">=16"
+    },
+    "publishConfig": {
+        "access": "public"
     }
 }