78 lines
2.0 KiB
YAML
78 lines
2.0 KiB
YAML
name: "Docs"
|
|
on:
|
|
workflow_dispatch:
|
|
pull_request:
|
|
push:
|
|
branches:
|
|
- main
|
|
|
|
env:
|
|
RUST_BACKTRACE: 1
|
|
CARGO_TERM_COLOR: always
|
|
CLICOLOR: 1
|
|
CLICOLOR_FORCE: 1
|
|
|
|
permissions:
|
|
contents: read
|
|
|
|
# Only allow one run of the workflow per branch / PR at a time.
|
|
concurrency:
|
|
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
|
|
cancel-in-progress: true
|
|
|
|
jobs:
|
|
# Check links in docs
|
|
check-links:
|
|
name: "Check links"
|
|
runs-on: ubuntu-24.04
|
|
steps:
|
|
- name: Checkout sources
|
|
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
|
with:
|
|
persist-credentials: false
|
|
|
|
- name: Check repo-local links
|
|
uses: lycheeverse/lychee-action@8646ba30535128ac92d33dfc9133794bfdd9b411 # v2.8.0
|
|
with:
|
|
args: ". --offline --verbose --no-progress"
|
|
fail: true
|
|
|
|
# Generate docs content
|
|
generate-docs:
|
|
name: "Generate usage docs"
|
|
runs-on: ubuntu-24.04
|
|
steps:
|
|
- name: Checkout
|
|
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
|
|
with:
|
|
persist-credentials: false
|
|
|
|
- name: Set up rust toolchain
|
|
uses: dtolnay/rust-toolchain@e97e2d8cc328f1b50210efc529dca0028893a2d9 # v1
|
|
with:
|
|
toolchain: stable
|
|
|
|
- name: Enable cargo cache
|
|
uses: Swatinem/rust-cache@c19371144df3bb44fab255c43d04cbc2ab54d1c4 # v2.9.1
|
|
|
|
- name: Create dirs
|
|
run: mkdir -p ./md ./man
|
|
|
|
- name: Build markdown info
|
|
run: cargo xtask gen docs markdown --out ./md/brush.md
|
|
|
|
- name: Upload markdown docs
|
|
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
|
|
with:
|
|
name: docs-markdown
|
|
path: md
|
|
|
|
- name: Build man pages
|
|
run: cargo xtask gen docs man --output-dir ./man
|
|
|
|
- name: Upload man pages
|
|
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
|
|
with:
|
|
name: docs-man
|
|
path: man
|