docs: add desktop notifications with hooks tip #105
Workflow file for this run
This file contains hidden or 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
| # Lints the documentation source in docs/**: markdownlint for style | |
| # and lychee (offline) to verify that every relative Markdown link | |
| # resolves to a real file. Portable relative links are what the Hugo | |
| # module mount on docs.docker.com resolves, so broken ones would break | |
| # the downstream build (see docs-upstream.yml). | |
| name: docs-lint | |
| permissions: | |
| contents: read | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.ref }} | |
| cancel-in-progress: ${{ github.ref != 'refs/heads/main' }} | |
| on: | |
| push: | |
| branches: [main] | |
| paths: | |
| - ".github/workflows/docs-lint.yml" | |
| - "docs/**" | |
| - "scripts/docs-check-canonical.sh" | |
| pull_request: | |
| paths: | |
| - ".github/workflows/docs-lint.yml" | |
| - "docs/**" | |
| - "scripts/docs-check-canonical.sh" | |
| jobs: | |
| markdownlint: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | |
| # Run from docs/ so the globs and ignores in .markdownlint-cli2.yaml | |
| # resolve the same way as a local `npx markdownlint-cli2` run. | |
| - name: Lint Markdown | |
| run: npx --yes markdownlint-cli2@0.22.1 | |
| working-directory: docs | |
| canonical-check: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | |
| # Mounted pages must canonicalize to their docs.docker.com URL | |
| # (STYLE.md "Canonical URLs"); catches pages added without one. | |
| - name: Check canonical front matter | |
| run: ./scripts/docs-check-canonical.sh | |
| link-check: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 | |
| - name: Check relative links | |
| uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0 | |
| with: | |
| # Verbatim (code block) links are excluded by lychee's defaults. | |
| # index.md and 404.md are github.io-only landing pages whose | |
| # links are HTML anchors resolved on the rendered site; the | |
| # muffet check (task docs-check-links) covers them. | |
| args: >- | |
| --offline --no-progress | |
| --exclude-path docs/index.md --exclude-path docs/404.md | |
| "docs/**/*.md" | |
| fail: true |