Deploy as package to GH packages

Author: dem1fo

.github/workflows/publish.yaml

@@ -0,0 +1,42 @@
+name: Publish @wfp/common-identifier-algorithm-shared
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+      - "v*.*.*-*"
+
+permissions:
+  checks: write
+  contents: read
+  packages: write
+  pull-requests: read
+
+jobs:
+  test:
+    uses: "./.github/workflows/test.yaml"
+  publish:
+    runs-on: ubuntu-latest
+    needs:
+      - test
+    steps:
+      - name: Checkout source
+        uses: actions/checkout@v4
+      
+      - name: Setup nodeJS
+        uses: actions/setup-node@v4
+        with:
+          node-version: "24"
+          registry-url: "https://npm.pkg.github.com"
+          scope: "@wfp"
+      
+      - name: Install dependencies
+        run: npm install
+      
+      - name: Build package
+        run: npm run build
+      
+      - name: Publish to GitHub packages
+        run: npm publish
+        env:
+          NPM_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yaml

@@ -1,10 +1,19 @@
 name: RunTests
 on:
   push:
-    branches: ['main', 'develop']
+    branches: 
+      - main
+      - develop
+      - feat/*
   pull_request:
     branches: ['main']
     types: [opened, reopened, edited]
+  workflow_call:
+
+permissions:
+  checks: write
+  contents: read
+  pull-requests: read
 
 jobs:
   RunTestSuite:
@@ -19,7 +28,7 @@ jobs:
       - name: Install NodeJS
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 24
 
       - name: Install node packages
         run: npm install

.npmrc

@@ -0,0 +1,2 @@
+@wfp:registry=https://npm.pkg.github.com
+//npm.pkg.github.com/:_authToken=${NPM_TOKEN}

examples/example_algorithm/_generic_hasher.ts

@@ -14,8 +14,8 @@
 // You should have received a copy of the GNU Affero General Public License
 // along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-import { joinFieldsForHash, cleanValueList, extractAlgoColumnsFromObject, BaseHasher } from 'common-identifier-algorithm-shared';
-import type { Config, Validator, makeHasherFunction } from 'common-identifier-algorithm-shared';
+import { joinFieldsForHash, cleanValueList, extractAlgoColumnsFromObject, BaseHasher } from '../../src';
+import type { Config, Validator, makeHasherFunction } from '../../src';
 
 class GenericHasher extends BaseHasher {
     constructor(config: Config.CoreConfiguration["algorithm"]) {

package-lock.json

@@ -1,26 +1,34 @@
 {
-  "name": "common-identifier-algorithm-shared",
-  "version": "1.2.0",
+  "name": "@wfp/common-identifier-algorithm-shared",
+  "version": "2.0.0",
   "description": "Generate psuedonymous identifiers from tabular data",
   "author": "World Food Programme",
   "license": "AGPL-3.0-or-later",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "files": [
-    "dist"
+    "dist",
+    "README.md",
+    "docs"
   ],
   "type": "module",
   "scripts": {
     "build": "tsc",
     "watch": "tsc -w",
     "prepare": "npm run build",
+    "clean": "git clean -xdf dist coverage",
+    "clean:all": "git clean -xdf dist coverage node_modules",
+    "publish:dry": "npm publish --dry-run",
     "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage --config=jest.config.js",
     "test:ci": "node --experimental-vm-modules node_modules/jest/bin/jest.js --ci --coverage --config=jest.ci.config.js"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/wfp/common-identifier-algorithm-shared.git"
   },
+  "publishConfig": {
+    "registry": "https://npm.pkg.github.com"
+  },
   "bugs": {
     "url": "https://github.com/wfp/common-identifier-algorithm-shared/issues"
   },

package.json

@@ -27,5 +27,5 @@
     "declaration": true,    
   },
   "include": ["src/**/*.ts"],
-  "exclude": ["node_modules", "tests", "dist", "tmp", "examples"]
+  "exclude": ["node_modules", "tests", "dist", "tmp"]
 }