From c31d6c174e4d54ed1ddfb6c4ed13252a8eb3573e Mon Sep 17 00:00:00 2001 From: gotbadger Date: Mon, 28 Aug 2023 10:30:16 +0100 Subject: [PATCH] ci(docs): check command docs are up to date --- .github/workflows/command_doc_check.yml | 27 +++++++++++++++++++++++++ .github/workflows/lint_pr.yml | 1 + 2 files changed, 28 insertions(+) create mode 100644 .github/workflows/command_doc_check.yml diff --git a/.github/workflows/command_doc_check.yml b/.github/workflows/command_doc_check.yml new file mode 100644 index 000000000..e20c6e093 --- /dev/null +++ b/.github/workflows/command_doc_check.yml @@ -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 diff --git a/.github/workflows/lint_pr.yml b/.github/workflows/lint_pr.yml index 889e2f232..e0184d4fe 100644 --- a/.github/workflows/lint_pr.yml +++ b/.github/workflows/lint_pr.yml @@ -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: