diff --git a/.github/workflows/dependency_review.yml b/.github/workflows/dependency_review.yml deleted file mode 100644 index 5104c94..0000000 --- a/.github/workflows/dependency_review.yml +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Check file name case - -on: - pull_request: - branches: - - main - -jobs: - case: - name: Check for licences not being allowed - runs-on: ubuntu-latest - strategy: - matrix: - folder: ["docs"] - permissions: - contents: read - steps: - - uses: actions/checkout@v3 - - - name: Dependency review - uses: ConsenSys/docs-gha/dependency-review@main - with: - GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/links.yml b/.github/workflows/links.yml new file mode 100644 index 0000000..452cf45 --- /dev/null +++ b/.github/workflows/links.yml @@ -0,0 +1,22 @@ +--- +name: Check for broken links + +on: + pull_request: + branches: + - main + +jobs: + + linkCheck: + name: Link Checking + runs-on: ubuntu-latest + strategy: + matrix: + file-extensions: [".md", ".mdx"] + steps: + - uses: actions/checkout@v4 + - name: LinkCheck + uses: ConsenSys/docs-gha/linkcheck@main + with: + FILE_EXTENSION: ${{ matrix.file-extensions }} diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index 61bd12a..72a83db 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -1,5 +1,5 @@ --- -name: Check for lint, spelling and link errors +name: Check for lint errors on: pull_request: @@ -8,26 +8,19 @@ on: jobs: lint: - name: Lint Code Base, Spelling, Link Check + name: Lint runs-on: ubuntu-latest permissions: contents: read steps: - uses: actions/checkout@v4 - - name: Lint + + - name: Lint code uses: ConsenSys/docs-gha/lint@main with: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - linkCheck: - name: Link Checking - runs-on: ubuntu-latest - strategy: - matrix: - file-extensions: [".md", ".mdx"] - steps: - - uses: actions/checkout@v4 - - name: LinkCheck - uses: ConsenSys/docs-gha/linkcheck@main + - name: Lint markdown + uses: ConsenSys/docs-gha/lint-markdown@main with: - FILE_EXTENSION: ${{ matrix.file-extensions }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/spelling.yml b/.github/workflows/spelling.yml index 09b64d6..f20dc86 100644 --- a/.github/workflows/spelling.yml +++ b/.github/workflows/spelling.yml @@ -5,7 +5,6 @@ on: pull_request: branches: - main - - vale jobs: vale: @@ -20,4 +19,5 @@ jobs: uses: Consensys/docs-gha/spelling@main with: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + FILEPATHS: "docs" diff --git a/package-lock.json b/package-lock.json index e53aa11..c85e8e1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -24,9 +24,9 @@ "@commitlint/cli": "^18.2.0", "@commitlint/config-conventional": "^18.1.0", "@docusaurus/eslint-plugin": "^3.5.2", - "@docusaurus/module-type-aliases": "^3.3.2", - "@docusaurus/tsconfig": "^3.3.2", - "@docusaurus/types": "^3.3.2", + "@docusaurus/module-type-aliases": "^3.5.2", + "@docusaurus/tsconfig": "^3.5.2", + "@docusaurus/types": "^3.5.2", "@semantic-release/changelog": "^6.0.3", "@semantic-release/commit-analyzer": "^10.0.4", "@semantic-release/git": "^10.0.1", @@ -3590,9 +3590,9 @@ } }, "node_modules/@docusaurus/tsconfig": { - "version": "3.4.0", - "resolved": "https://registry.npmjs.org/@docusaurus/tsconfig/-/tsconfig-3.4.0.tgz", - "integrity": "sha512-0qENiJ+TRaeTzcg4olrnh0BQ7eCxTgbYWBnWUeQDc84UYkt/T3pDNnm3SiQkqPb+YQ1qtYFlC0RriAElclo8Dg==", + "version": "3.5.2", + "resolved": "https://registry.npmjs.org/@docusaurus/tsconfig/-/tsconfig-3.5.2.tgz", + "integrity": "sha512-rQ7toURCFnWAIn8ubcquDs0ewhPwviMzxh6WpRjBW7sJVCXb6yzwUaY3HMNa0VXCFw+qkIbFywrMTf+Pb4uHWQ==", "dev": true }, "node_modules/@docusaurus/types": { diff --git a/package.json b/package.json index 680419b..c979b6f 100644 --- a/package.json +++ b/package.json @@ -48,9 +48,9 @@ "@commitlint/cli": "^18.2.0", "@commitlint/config-conventional": "^18.1.0", "@docusaurus/eslint-plugin": "^3.5.2", - "@docusaurus/module-type-aliases": "^3.3.2", - "@docusaurus/tsconfig": "^3.3.2", - "@docusaurus/types": "^3.3.2", + "@docusaurus/module-type-aliases": "^3.5.2", + "@docusaurus/tsconfig": "^3.5.2", + "@docusaurus/types": "^3.5.2", "@semantic-release/changelog": "^6.0.3", "@semantic-release/commit-analyzer": "^10.0.4", "@semantic-release/git": "^10.0.1",