docs: refactor cli run reference #3146
Workflow file for this run
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: validate | |
concurrency: | |
group: ${{ github.workflow }}-${{ github.ref }} | |
cancel-in-progress: true | |
on: | |
workflow_dispatch: | |
push: | |
branches: | |
- 'master' | |
- '[0-9]+.[0-9]+' | |
tags: | |
- 'v*' | |
pull_request: | |
jobs: | |
validate: | |
runs-on: ubuntu-20.04 | |
strategy: | |
fail-fast: false | |
matrix: | |
target: | |
- lint | |
- shellcheck | |
- validate-vendor | |
- update-authors # ensure authors update target runs fine | |
steps: | |
- | |
name: Checkout | |
uses: actions/checkout@v4 | |
- | |
name: Run | |
uses: docker/bake-action@v4 | |
with: | |
targets: ${{ matrix.target }} | |
# check that the generated Markdown and the checked-in files match | |
validate-md: | |
runs-on: ubuntu-20.04 | |
steps: | |
- | |
name: Checkout | |
uses: actions/checkout@v4 | |
- | |
name: Generate | |
shell: 'script --return --quiet --command "bash {0}"' | |
run: | | |
make -f docker.Makefile mddocs | |
- | |
name: Validate | |
run: | | |
if [[ $(git diff --stat) != '' ]]; then | |
echo 'fail: generated files do not match checked-in files' | |
git --no-pager diff | |
exit 1 | |
fi | |
validate-make: | |
runs-on: ubuntu-20.04 | |
strategy: | |
fail-fast: false | |
matrix: | |
target: | |
- yamldocs # ensure yamldocs target runs fine | |
- manpages # ensure manpages target runs fine | |
steps: | |
- | |
name: Checkout | |
uses: actions/checkout@v4 | |
- | |
name: Run | |
shell: 'script --return --quiet --command "bash {0}"' | |
run: | | |
make -f docker.Makefile ${{ matrix.target }} |