fix: updating readme and keywords and setting up semantic release

.github/workflows/ci.yaml

@@ -11,3 +11,24 @@ jobs:
       - run: yarn install
       - run: yarn test
       - run: yarn build
+  release:
+    needs: lint_test_and_build
+    permissions:
+      contents: write
+      id-token: write
+    # https://git.luolix.topmunity/t/how-do-i-specify-job-dependency-running-in-another-workflow/16482
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main' && !contains(github.event.head_commit.message, 'chore(release):')
+    runs-on: ubuntu-latest
+    concurrency: release
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+      - run: yarn install
+      - run: yarn build
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release

README.md

@@ -3,7 +3,7 @@
 [![ci](https://img.shields.io/github/actions/workflow/status/chanind/penman-js/ci.yaml?branch=main)](https://github.com/chanind/penman-js)
 [![Npm](https://img.shields.io/npm/v/penman-js)](https://www.npmjs.com/package/penman-js)
 
-Javascript port of [Penman Python library](https://github.com/goodmami/penman) for AMR.
+Javascript port of [Penman Python library](https://github.com/goodmami/penman) for Abstract Meaning Representation (AMR).
 
 ## About
 

package.json

@@ -7,7 +7,10 @@
   "module": "build/module/index.js",
   "repository": "https://github.com/chanind/penman-js",
   "license": "MIT",
-  "keywords": [],
+  "keywords": [
+    "AMR",
+    "Abstract Meaning Representation"
+  ],
   "exports": {
     ".": {
       "import": "./build/module/index.js",
@@ -48,7 +51,6 @@
     "doc:html": "typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --out build/docs",
     "doc:json": "typedoc src/ --exclude **/*.spec.ts --target ES6 --mode file --json build/docs/typedoc.json",
     "doc:publish": "gh-pages -m \"[ci skip] Updates\" -d build/docs",
-    "version": "standard-version",
     "reset-hard": "git clean -dfx && git reset --hard && yarn",
     "prepare-release": "run-s reset-hard test cov:check doc:html version doc:publish"
   },
@@ -67,6 +69,12 @@
   "devDependencies": {
     "@ava/typescript": "^4.1.0",
     "@istanbuljs/nyc-config-typescript": "^1.0.1",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/commit-analyzer": "^11.1.0",
+    "@semantic-release/git": "^10.0.1",
+    "@semantic-release/github": "^9.2.6",
+    "@semantic-release/npm": "^11.0.2",
+    "@semantic-release/release-notes-generator": "^12.1.0",
     "@types/lodash.clonedeep": "^4.5.9",
     "@types/lodash.differencewith": "^4.5.9",
     "@types/lodash.isequal": "^4.5.8",
@@ -77,7 +85,6 @@
     "@typescript-eslint/parser": "^6.15.0",
     "ava": "^6.0.1",
     "codecov": "^3.5.0",
-    "cz-conventional-changelog": "^3.3.0",
     "eslint": "^8.56.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
@@ -88,7 +95,7 @@
     "nyc": "^15.1.0",
     "open-cli": "^8.0.0",
     "prettier": "^3.1.1",
-    "standard-version": "^9.0.0",
+    "semantic-release": "^22.0.12",
     "ts-node": "^10.9.2",
     "typedoc": "^0.25.4",
     "typescript": "^5.3.0"
@@ -128,5 +135,15 @@
     "exclude": [
       "**/*.spec.js"
     ]
+  },
+  "release": {
+    "plugins": [
+      "@semantic-release/commit-analyzer",
+      "@semantic-release/release-notes-generator",
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/git",
+      "@semantic-release/github"
+    ]
   }
 }