chore: bump node v 20 and add semantic release [OTE-804] (#237)

.github/workflows/commitlint.yml

@@ -0,0 +1,33 @@
+name: "[v4-client-js] Conventional PR Title"
+on:
+  pull_request:
+    types: ['opened', 'edited', 'reopened', 'synchronize']
+
+jobs:
+  conventional-pr-title:
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: ./v4-client-js
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Use Node.js 20.8.1
+        uses: actions/setup-node@v3
+        with:
+          node-version: 20.8.1
+          registry-url: https://registry.npmjs.org
+          cache: "npm"
+          cache-dependency-path: '**/package-lock.json'
+
+      - name: Install dependencies
+        run: |
+          npm install @commitlint/config-conventional
+
+      - name: Lint PR Title
+        run: |
+          echo "${PR_TITLE}" | npx commitlint --config commitlint.config.js
+        env:
+          PR_TITLE: '${{ github.event.pull_request.title }}'
+

.github/workflows/js-lint-build-test.yml

@@ -20,10 +20,10 @@ jobs:
       - name: Check out repository code
         uses: actions/checkout@v3
 
-      - name: Use Node.js 16
+      - name: Use Node.js 20.8.1
         uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 20.8.1
           registry-url: https://registry.npmjs.org
           cache: "npm"
           cache-dependency-path: '**/package-lock.json'

.github/workflows/js-publish.yml

@@ -28,7 +28,7 @@ jobs:
       - name: Npm
         uses: actions/setup-node@v3
         with:
-          node-version: 16
+          node-version: 20.8.1
           registry-url: https://registry.npmjs.org
           cache: "npm"
           cache-dependency-path: '**/package-lock.json'
@@ -38,7 +38,10 @@ jobs:
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN_READ }}
 
-      - name: Publish
-        run: ./scripts/publish-if-not-exists.sh
+    # Run semantic-release to automatically bump the version based on PR title
+      - name: Run semantic-release
+        run: npm run release
         env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN_WRITE }}
+

README.md

@@ -37,3 +37,34 @@ The original client can be found [here](https://github.com/asnefedovv/dydx-v4-cl
 # Third-party Clients
 
 By clicking the above links to third-party clients, you will leave the dYdX Trading Inc. (“dYdX”) GitHub repository and join repositories made available by third parties, which are independent from and unaffiliated with dYdX. dYdX is not responsible for any action taken or content on third-party repositories.
+
+# Contributing
+
+## We use [Conventional Commits](https://github.com/conventional-changelog/commitlint)
+We use a commit-msg hook to check if your commit messages meet the conventional commit format.
+
+In general the pattern looks like this:
+
+`type(scope?): subject`  #scope is optional; multiple scopes are supported (current delimiter options: "/", "\" and ",")
+
+### Real world examples can look like this:
+`chore: run tests on travis ci`
+`fix(server): send cors headers`
+`feat(blog): add comment section`
+
+Common types according to commitlint-config-conventional can be:
+
+build
+chore
+ci
+docs
+feat
+fix
+perf
+refactor
+revert
+style
+test
+
+## Any contributions you make will be under the same License
+When you submit code changes, your submissions are understood to be under the same [License](https://github.com/dydxprotocol/v4-web/blob/master/LICENSE) that covers the project.

v4-client-js/.nvmrc

@@ -1 +1 @@
-v18
+v20.8.1

v4-client-js/.releaserc

@@ -0,0 +1,11 @@
+{
+  "branches": ["main"],
+  "tagFormat": "v4-client-js@${version}",
+  "plugins": [
+    "@semantic-release/commit-analyzer",
+    "@semantic-release/release-notes-generator",
+    "@semantic-release/changelog",
+    "@semantic-release/npm",
+    "@semantic-release/git"
+  ]
+}

v4-client-js/commitlint.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'subject-case': [0, 'never'],
+    'header-max-length': [2, 'always', 120],
+    'body-max-line-length': [0, 'always', 120],
+  },
+};