Skip to content

Commit

Permalink
ci(docs): check command docs are up to date
Browse files Browse the repository at this point in the history
  • Loading branch information
gotbadger committed Aug 28, 2023
1 parent f024b67 commit c31d6c1
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .github/workflows/command_doc_check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Command Doc Check
on:
push:
branches:
- main
pull_request:
types:
- opened
- synchronize
- reopened
permissions:
contents: read
jobs:
validate:
runs-on: ubuntu-latest
timeout-minutes: 10

steps:
- uses: actions/checkout@v3
- name: Set up Go
uses: actions/setup-go@v4
with:
go-version: 1.19
- name: Generate command docs
run: go run ./scripts/gen-doc-yaml.go
- name: Check no uncommited changes
run: git diff --exit-code
1 change: 1 addition & 0 deletions .github/workflows/lint_pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ jobs:
main:
name: Validate PR title
runs-on: ubuntu-latest
continue-on-error: true
steps:
- uses: amannn/action-semantic-pull-request@v5
env:
Expand Down

0 comments on commit c31d6c1

Please sign in to comment.