Files
wehub-resource-sync 36b3af2e3d
PR Check / Code Quality: Format (push) Failing after 1s
PR Check / Code Quality: Lint (darwin) (push) Failing after 0s
PR Check / Code Quality: Lint (freebsd) (push) Failing after 1s
PR Check / Code Quality: Lint (windows) (push) Failing after 1s
PR Check / Code Quality: Lint (linux) (push) Failing after 1s
PR Check / Security: Vulnerability Scan (push) Failing after 0s
Update Documentation / update-docs (push) Failing after 2s
PR Check / Code Quality: Vendor (push) Failing after 1s
PR Check / Code Quality: Coverage (push) Failing after 0s
PR Check / Tests: Unit (macos-latest) (push) Has been cancelled
PR Check / Tests: Unit (ubuntu-24.04) (push) Has been cancelled
PR Check / Tests: Unit (ubuntu-24.04-arm) (push) Has been cancelled
PR Check / Tests: Unit (windows-latest) (push) Has been cancelled
chore: import upstream snapshot with attribution
2026-07-13 12:22:06 +08:00

69 lines
1.5 KiB
YAML

name: Update Documentation
on:
push:
branches:
- main
workflow_dispatch:
# Default to read-only; the publishing job escalates to contents: write.
permissions:
contents: read
concurrency:
group: ${{github.workflow}}-${{ github.ref }}
cancel-in-progress: true
env:
GO_VERSION: '1.25'
PROJECT_NAME: witr
jobs:
update-docs:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- name: Checkout
uses: actions/checkout@v7
with:
fetch-depth: 0
- name: Set up Go
uses: actions/setup-go@v6
with:
go-version: ${{ env.GO_VERSION }}
check-latest: true
- name: Create man.1 documentation
run: |
go run internal/tools/docgen/main.go -out ./docs/cli -format man
- name: Create markdown documentation
run: |
go run internal/tools/docgen/main.go -out ./docs/cli -format markdown
- name: Commit and push documentation
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
git config user.name "github-actions[bot]"
git config user.email "github-actions[bot]@users.noreply.github.com"
git add docs/cli
if git diff --cached --quiet; then
echo "No changes to commit"
exit 0
fi
git commit -m "docs: update CLI documentation"
- name: Push documentation
run: |
git push origin ${{ github.ref }}