From 23abdbf5c7d98ce1fc23d99058cda47e337353b9 Mon Sep 17 00:00:00 2001 From: Joshua Fernandes Date: Fri, 13 Sep 2024 10:55:25 +1000 Subject: [PATCH] update with new gha workflows --- .github/workflows/dependency_review.yml | 24 ------------------------ .github/workflows/links.yml | 22 ++++++++++++++++++++++ .github/workflows/lint.yml | 21 +++++++-------------- .github/workflows/spelling.yml | 23 +++++++++++++++++++++++ 4 files changed, 52 insertions(+), 38 deletions(-) delete mode 100644 .github/workflows/dependency_review.yml create mode 100644 .github/workflows/links.yml create mode 100644 .github/workflows/spelling.yml 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 1f26980..13277f6 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,27 +8,20 @@ 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 }} + CONFIG_FILE: ".markdownlint.yaml" \ No newline at end of file diff --git a/.github/workflows/spelling.yml b/.github/workflows/spelling.yml new file mode 100644 index 0000000..f20dc86 --- /dev/null +++ b/.github/workflows/spelling.yml @@ -0,0 +1,23 @@ +--- +name: Check for spelling with vale + +on: + pull_request: + branches: + - main + +jobs: + vale: + name: Spelling + runs-on: ubuntu-latest + permissions: + contents: read + steps: + - uses: actions/checkout@v4 + + - name: Vale + uses: Consensys/docs-gha/spelling@main + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + FILEPATHS: "docs" +