Merge pull request #2 from Dentity-Development/ft/ci-cd

chore: setup the github action, add release action, update package name

.github/workflows/lint.yaml

@@ -0,0 +1,28 @@
+name: ESLint check
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+    branches: ['main']
+
+jobs:
+  run-eslint:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20.x]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - run: yarn install
+      - run: yarn lint

.github/workflows/release.yaml

@@ -0,0 +1,37 @@
+name: Deployment CI
+
+on:
+  push:
+    branches: ['release']
+
+permissions:
+  contents: write
+
+jobs:
+  build-and-deploy:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20.x]
+
+    env:
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'yarn'
+      - run: yarn install
+      - run: yarn build && touch dist/.nojekyll
+
+      - name: Semantic Release
+        uses: cycjimmy/semantic-release-action@v4
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Publish
+        run: npm publish --//registry.npmjs.org/:_authToken="${{ secrets.NPM_TOKEN }}"

.github/workflows/test.yaml

@@ -0,0 +1,28 @@
+name: Run Test case
+
+on:
+  pull_request:
+    types: [opened, synchronize]
+    branches: ['main']
+
+jobs:
+  run-test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20.x]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha }}
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+
+      - run: yarn install
+      - run: yarn test

.releaserc

@@ -1,7 +1,8 @@
 {
   "branches": [
     "main",
-    "master"
+    "master",
+    "release"
   ],
   "plugins": [
     "@semantic-release/commit-analyzer",

README.md

@@ -1,4 +1,4 @@
-# dentity-ens-client
+# @dentity/ens-client
 
 A combination of [Dentity](https://dentity.com)  and [ENS domains](https://ens.domains) to verify basic information for ENS domain owners.
 
@@ -7,15 +7,15 @@ A combination of [Dentity](https://dentity.com)  and [ENS domains](https://ens.d
 ## Install
 
 ``` sh
-npm i dentity-ens-client
+npm i @dentity/ens-client
 ```
 
 ## Getting started
 
 The simplest example is to get all verifcations shared by Dentity users with their ENS domain. You can easily get all those verifications by initially add to their ENS domain.
 ``` ts
 import { EnsPublicClient, createEnsPublicClient } from '@ensdomains/ensjs';
-import { CredentialTemplate, EnsDentityClient } from 'dentity-ens-client';
+import { CredentialTemplate, EnsDentityClient } from '@dentity/ens-client';
 import { http } from 'viem';
 import { mainnet } from 'viem/chains';
 
@@ -40,7 +40,7 @@ EnsDentityClient.initialize(client as any, 'alice.eth').then((ensClient) => {
 Currently Dentity is supporting sharing a number of verification types for ENS domain. You can specifically get any verification by passing in a specific credential template. You can then verify the correctness of that verification.
 ``` ts
 import { EnsPublicClient, createEnsPublicClient } from '@ensdomains/ensjs';
-import { CredentialTemplate, DentityEnsClient } from 'dentity-ens-client';
+import { CredentialTemplate, DentityEnsClient } from '@dentity/ens-client';
 import { http } from 'viem';
 import { mainnet } from 'viem/chains';
 

examples/nodejs/index.ts

@@ -1,5 +1,5 @@
 import { EnsPublicClient, createEnsPublicClient } from '@ensdomains/ensjs';
-import { CredentialTemplate, DentityEnsClient } from 'dentity-ens-client';
+import { CredentialTemplate, DentityEnsClient } from '@dentity/ens-client';
 import { http } from 'viem';
 import { mainnet } from 'viem/chains';
 

examples/nodejs/package.json

@@ -11,7 +11,7 @@
   "license": "ISC",
   "dependencies": {
     "@ensdomains/ensjs": "^4.0.1",
-    "dentity-ens-client": "link:../../"
+    "@dentity/ens-client": "link:../../"
   },
   "devDependencies": {
     "ts-node": "^10.9.2",

examples/nodejs/yarn.lock

@@ -236,7 +236,7 @@ delayed-stream@~1.0.0:
   resolved "https://registry.yarnpkg.com/delayed-stream/-/delayed-stream-1.0.0.tgz#df3ae199acadfb7d440aaae0b29e2272b24ec619"
   integrity sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==
 
-"dentity-ens-client@link:../..":
+"@dentity/ens-client@link:../..":
   version "0.0.0"
   uid ""
 

examples/react/package.json

@@ -22,7 +22,7 @@
   "dependencies": {
     "@ensdomains/ensjs": "^4.0.1",
     "copy-to-clipboard": "^3.3.3",
-    "dentity-ens-client": "link:../../",
+    "@dentity/ens-client": "link:../../",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "react-json-view": "^1.21.3",

examples/react/src/components/Modal/CredentialDetailModal.tsx

@@ -7,7 +7,7 @@ import MiniLoading from '../Icon/MiniLoading';
 import {
   DentityEnsClient,
   VerifiableCredentialPresentationResponse,
-} from 'dentity-ens-client';
+} from '@dentity/ens-client';
 import { toast } from 'react-toastify';
 import Tick from '../Icon/Tick';
 

examples/react/src/pages/EnsDetail/index.tsx

@@ -6,7 +6,7 @@ import {
   DentityEnsClient,
   VerifiableCredentialPresentation,
   CredentialTemplate,
-} from 'dentity-ens-client';
+} from '@dentity/ens-client';
 import { useLayoutEffect, useMemo, useState } from 'react';
 import Discord from '../../components/Icon/Discord';
 import Email from '../../components/Icon/Email';

examples/react/vite.config.ts

@@ -21,6 +21,6 @@ export default defineConfig({
     port: 3000,
   },
   optimizeDeps: {
-    include: ['dentity-ens-client'],
+    include: ['@dentity/ens-client'],
   },
 });

examples/react/yarn.lock

@@ -901,7 +901,7 @@ delayed-stream@~1.0.0:
   resolved "https://registry.yarnpkg.com/delayed-stream/-/delayed-stream-1.0.0.tgz#df3ae199acadfb7d440aaae0b29e2272b24ec619"
   integrity sha512-ZySD7Nf91aLB0RxL4KGrKHBXl7Eds1DAmEdcoVawXnLD7SDhpNgtuII2aAkg7a7QS41jxPSZ17p4VdGnMHk3MQ==
 
-"dentity-ens-client@link:../..":
+"@dentity/ens-client@link:../..":
   version "0.0.0"
   uid ""
 

package.json

@@ -1,7 +1,7 @@
 {
   "name": "@dentity/ens-client",
   "repository": {
-    "url": "https://github.com/Dentity-Development/ens-client.git"
+    "url": "git+https://github.com/Dentity-Development/ens-client.git"
   },
   "version": "1.0.0",
   "author": "Dentity",
@@ -66,5 +66,13 @@
   "resolutions": {
     "wrap-ansi": "7.0.0",
     "string-width": "4.2.3"
+  },
+  "bugs": {
+    "url": "https://github.com/Dentity-Development/ens-client/issues"
+  },
+  "homepage": "https://github.com/Dentity-Development/ens-client#readme",
+  "directories": {
+    "example": "examples",
+    "test": "tests"
   }
 }