diff --git a/.github/workflows/check-docs.yml b/.github/workflows/check-docs.yml new file mode 100644 index 0000000..0d372af --- /dev/null +++ b/.github/workflows/check-docs.yml @@ -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 diff --git a/.github/workflows/release-dev-version.yml b/.github/workflows/release-dev-version.yml index 683825e..8581b3d 100644 --- a/.github/workflows/release-dev-version.yml +++ b/.github/workflows/release-dev-version.yml @@ -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 diff --git a/.github/workflows/release-productive-version.yml b/.github/workflows/release-productive-version.yml index c0b5f9a..357818c 100644 --- a/.github/workflows/release-productive-version.yml +++ b/.github/workflows/release-productive-version.yml @@ -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