Skip to content

3782 - Add doc lint github action #4

3782 - Add doc lint github action

3782 - Add doc lint github action #4

Workflow file for this run

name: Documentation - Check for lint/build errors
on:
pull_request:
paths:
- "**/*.md"
branches:
- main
jobs:
# This job is commented out because of the missing package-lock.json file
# lint:
# name: Lint Code Base, Spelling
# runs-on: [self-hosted, ubuntu-22.04, X64, small]
# timeout-minutes: 10
# permissions:
# contents: read
# env:
# NODE_VERSION: v20.9.0
# steps:
# - uses: actions/checkout@v4
# - name: Create .nvmrc file
# run: |
# echo "${{ env.NODE_VERSION }}" > .nvmrc
# - name: Lint
# uses: Consensys/docs-gha/lint@main
# with:
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
linkCheck:
name: Link Checking
runs-on: [self-hosted, ubuntu-22.04, X64, small]
timeout-minutes: 10
permissions:
contents: read
strategy:
matrix:
file-extensions: [".md"]
steps:
- uses: actions/checkout@v4
- name: LinkCheck
uses: Consensys/docs-gha/linkcheck@main
with:
FILE_EXTENSION: '${{ matrix.file-extensions }}'
CONFIG_FILE: 'doc_config.json'