3782 - Add doc lint github action

.github/ISSUE_TEMPLATE/operational_task_template.md

@@ -13,7 +13,6 @@ assignees: ''
 - Network scope: Select those that apply, or select All
 - [ ] All
 - [ ] Mainnet
-- [ ] Testnet - Goerli
 - [ ] Testnet - Sepolia
 - [ ] Devnet
 

.github/pull_request_template.md

@@ -1,7 +1,35 @@
+## Description
+<!-- Provide a brief description of the changes in this PR -->
+
+## Related Issue
+
 This PR implements issue(s) #
+<!-- If this PR addresses an existing issue, please link to it here -->
+<!-- e.g., Fixes #123 -->
+
+## Type of Change
+<!-- Mark the appropriate option with an "x" -->
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+## How Has This Been Tested?
+<!-- Describe the tests you ran to verify your changes -->
+<!-- Include details of your testing environment, and the tests you ran -->
+
+## Checklist:
+<!-- Mark completed items with an "x" -->
 
-### Checklist
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] I have informed the team of any breaking changes if there are any
+- [ ] My changes generate no new warnings
+- [ ] I wrote new tests for my new core changes
+- [ ] I have successfully ran tests, style checker and build against my new changes locally
+- [ ] Any dependent changes have been merged and published in downstream modules
 
-* [ ] I wrote new tests for my new core changes.
-* [ ] I have successfully ran tests, style checker and build against my new changes locally.
-* [ ] I have informed the team of any breaking changes if there are any.
+## Additional Notes
+<!-- Add any other information about the PR here -->

.github/workflows/doc-lint.yaml

@@ -0,0 +1,46 @@
+
+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'

doc_config.json

@@ -0,0 +1,25 @@
+{
+ "ignorePatterns": [
+ {
+ "pattern": "https://github.com/"
+ },
+ {
+ "pattern": "https://twitter.com/"
+ },
+ {
+ "pattern": "https://support.metamask.io/"
+ },
+ {
+ "pattern": "https://infura.io/faucet/linea"
+ },
+ {
+ "pattern": "https://www.infura.io/faucet/linea"
+ },
+ {
+ "pattern": "https://infura.io"
+ },
+ {
+ "pattern": "https://rpc.sepolia.linea.build"
+ }
+ ]
+}