Added Markdown scans and PR template #3
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: markdown | |
on: | |
pull_request: | |
paths: | |
- '.github/workflows/markdown.yml' | |
- '.github/markdownlint.json' | |
- '.github/markdownlint.jsonc' | |
- '**/*.md' | |
# Declare default permissions as read only. | |
permissions: read-all | |
jobs: | |
lint: | |
name: Lint markdown files | |
runs-on: ubuntu-latest | |
steps: | |
- name: Harden Runner | |
uses: step-security/harden-runner@cb605e52c26070c328afc4562f0b4ada7618a84e # v2.10.4 | |
with: | |
egress-policy: audit | |
- name: Checkout devtools | |
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
- name: Register markdownlint warning matcher | |
run: | | |
echo "::add-matcher::.github/markdownlint.json" | |
- name: Lint markdown files | |
uses: avto-dev/markdown-lint@04d43ee9191307b50935a753da3b775ab695eceb # v1.5.0 | |
with: | |
args: '**/*.md' | |
config: '.github/markdownlint.jsonc' | |
ignore: 'third_party_licenses.md CHANGELOG.md' | |
- name: Remove markdownlint warning matcher | |
if: always() | |
run: | | |
echo "::remove-matcher owner=markdownlint::" | |
check-links: | |
name: Check markdown links | |
runs-on: ubuntu-latest | |
steps: | |
- name: Checkout devtools | |
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
- name: Check links | |
uses: gaurav-nelson/github-action-markdown-link-check@1b916f2cf6c36510a6059943104e3c42ce6c16bc # master | |
# Checks all Markdown files, including those in subfolders, | |
# as the PR may involve removing referenced Markdown files. | |
with: | |
use-quiet-mode: 'yes' | |
use-verbose-mode: 'yes' | |
base-branch: ${{ github.base_ref }} | |
config-file: '.github/markdown-link-check.jsonc' | |