build: fix dependebot vulnerabilities (#38)

* build(deps): add resolutions for vunerable packages * ci: add pr title validation check and types check * ci: add permissions to the release workflow * chore: squash * build(deps): update commitlint package and convert config to ts * build(deps): update husky and remove config * chore: squash * docs: move clients and providers to usage
agoralabs-sh · Sep 11, 2024 · 0ad2131 · 0ad2131
1 parent a6214f4
commit 0ad2131
Show file tree

Hide file tree

Showing 32 changed files with 6,548 additions and 1,844 deletions.
diff --git a/.github/workflows/pull_request_checks.yml b/.github/workflows/pull_request_checks.yml
@@ -17,13 +17,29 @@ jobs:
       - name: "🧶 Setup Yarn Dependencies"
         uses: ./.github/actions/use-yarn-dependencies
 
+  ##
+  # validation
+  ##
+
+  validate_pr_title:
+    name: "Validate PR Title"
+    needs: install
+    runs-on: ubuntu-latest
+    steps:
+      - name: "🛎 Checkout"
+        uses: actions/checkout@v4
+      - name: "🧶 Setup Yarn Dependencies"
+        uses: ./.github/actions/use-yarn-dependencies
+      - name: "✅ Validate"
+        run: echo ${{ github.event.pull_request.title }} | yarn commitlint
+
   ##
   # lint, build documentation, build package and test
   ##
 
   lint:
     name: "Lint"
-    needs: install
+    needs: [install, validate_pr_title]
     runs-on: ubuntu-latest
     steps:
       - name: "🛎 Checkout"
@@ -33,9 +49,21 @@ jobs:
       - name: "👕 Lint"
         run: yarn lint
 
-  build_documenation:
+  type_check:
+    name: "Type Check"
+    needs: [install, validate_pr_title]
+    runs-on: ubuntu-latest
+    steps:
+      - name: "🛎 Checkout"
+        uses: actions/checkout@v4
+      - name: "🧶 Setup Yarn Dependencies"
+        uses: ./.github/actions/use-yarn-dependencies
+      - name: "🔍 Type Check"
+        run: yarn types:check
+
+  build_documentation:
     name: "Build Documentation"
-    needs: install
+    needs: [install, validate_pr_title]
     runs-on: ubuntu-latest
     steps:
       - name: "🛎 Checkout"
@@ -47,7 +75,7 @@ jobs:
 
   build_package:
     name: "Build Package"
-    needs: install
+    needs: [install, validate_pr_title]
     runs-on: ubuntu-latest
     steps:
       - name: "🛎 Checkout"
@@ -59,7 +87,7 @@ jobs:
 
   test:
     name: "Test"
-    needs: install
+    needs: [install, validate_pr_title]
     runs-on: ubuntu-latest
     steps:
       - name: "🛎 Checkout"

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -27,6 +27,10 @@ jobs:
   release:
     name: "Release"
     needs: install
+    permissions:
+      contents: write # to be able to publish a github release
+      issues: write # to be able to comment on released issues
+      pull-requests: write # to be able to comment on released pull requests
     runs-on: ubuntu-latest
     steps:
       - name: "🛎 Checkout"

diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
 yarn commitlint --edit "$1"
diff --git a/.husky/pre-commit b/.husky/pre-commit
@@ -1,4 +1 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
 yarn lint-staged
diff --git a/.huskyrc b/.huskyrc
diff --git a/README.md b/README.md
@@ -111,6 +111,7 @@ This will compile the Typescript source code into a `dist/` directory.
 | `yarn run lint`       | Runs the linter on `.js` and `.ts` files.                                          |
 | `yarn run prettier`   | Runs the prettier on `.js` and `.ts` files.                                        |
 | `yarn test`           | Runs the tests.                                                                    |
+| `yarn types:check`    | Performs a type check on the `src/` directory.                                     |
 
 <sup>[Back to top ^][table-of-contents]</sup>
 

diff --git a/commitlint.config.js b/commitlint.config.js
diff --git a/commitlint.config.ts b/commitlint.config.ts
@@ -0,0 +1,7 @@
+import type { UserConfig } from '@commitlint/types';
+
+const config: UserConfig = {
+  extends: ['@commitlint/config-conventional'],
+};
+
+export default config;
diff --git a/docs/scripts/sidebars.js b/docs/scripts/sidebars.js
@@ -7,38 +7,48 @@ const sidebars = {
     'terminology',
     {
       items: [
-        'clients/getting-started',
-        'clients/discover-providers',
-        'clients/enabling-a-client',
-        'clients/disabling-a-client',
-        'clients/signing-transactions',
-        'clients/posting-transactions',
-        'clients/signing-and-posting-transactions',
-        'clients/signing-a-message',
+        {
+          items: [
+            'clients/getting-started',
+            'clients/discover-providers',
+            'clients/enabling-a-client',
+            'clients/disabling-a-client',
+            'clients/signing-transactions',
+            'clients/posting-transactions',
+            'clients/signing-and-posting-transactions',
+            'clients/signing-a-message',
+          ],
+          label: 'Clients',
+          link: {
+            type: 'doc',
+            id: 'clients/index',
+          },
+          type: 'category',
+        },
+        {
+          items: [
+            'providers/getting-started',
+            'providers/responding-to-discover-requests',
+            'providers/responding-to-enable-requests',
+            'providers/responding-to-disable-requests',
+            'providers/responding-to-sign-transactions-requests',
+            'providers/responding-to-post-transactions-requests',
+            'providers/responding-to-sign-and-post-transactions-requests',
+            'providers/responding-to-sign-message-requests',
+            'providers/throwing-an-error',
+          ],
+          label: 'Providers',
+          link: {
+            type: 'doc',
+            id: 'providers/index',
+          },
+          type: 'category',
+        },
       ],
-      label: 'Clients',
+      label: 'Usage',
       link: {
         type: 'doc',
-        id: 'clients/index',
-      },
-      type: 'category',
-    },
-    {
-      items: [
-        'providers/getting-started',
-        'providers/responding-to-discover-requests',
-        'providers/responding-to-enable-requests',
-        'providers/responding-to-disable-requests',
-        'providers/responding-to-sign-transactions-requests',
-        'providers/responding-to-post-transactions-requests',
-        'providers/responding-to-sign-and-post-transactions-requests',
-        'providers/responding-to-sign-message-requests',
-        'providers/throwing-an-error',
-      ],
-      label: 'Providers',
-      link: {
-        type: 'doc',
-        id: 'providers/index',
+        id: 'usage/index',
       },
       type: 'category',
     },