Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions .github/workflows/check-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Check Generated Docs

on:
workflow_call:

permissions:
contents: read

jobs:
check-docs:
runs-on: ubuntu-24.04
steps:
- name: Checkout
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

- name: Set up Go
uses: actions/setup-go@4a3601121dd01d1626a1e23e37211e3254c1c06c # v6.0.0
with:
go-version-file: src/go.mod
cache-dependency-path: src/go.sum

- name: Regenerate docs
working-directory: src
run: go run github.com/swaggo/swag/cmd/swag@v1.16.6 init --requiredByDefault

- name: Fail if docs are out of date
run: |
git diff --exit-code -- src/docs/docs.go src/docs/swagger.json src/docs/swagger.yaml
8 changes: 6 additions & 2 deletions .github/workflows/release-dev-version.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,16 @@ on:
description: 'Version'
required: true

permissions: {}

permissions:
contents: read

jobs:
check-docs:
uses: ./.github/workflows/check-docs.yml

setup:
runs-on: ubuntu-24.04
needs: check-docs
steps:
- name: Set up QEMU
uses: docker/setup-qemu-action@ce360397dd3f832beb865e1373c09c0e9f86d70a # v4.0.0
Expand Down
8 changes: 6 additions & 2 deletions .github/workflows/release-productive-version.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,16 @@ on:
description: 'Version'
required: true

permissions: {}

permissions:
contents: read

jobs:
check-docs:
uses: ./.github/workflows/check-docs.yml

setup:
runs-on: ubuntu-24.04
needs: check-docs
steps:
- name: Set up QEMU
uses: docker/setup-qemu-action@ce360397dd3f832beb865e1373c09c0e9f86d70a # v4.0.0
Expand Down
Loading