Merge 6e1698e8200a2ffdc41f59b9e7bb16caa7ad60c4 into ad5d3b76dbf87f601e1e9cbfa998a114a54a1c75

Merge pull request #849 from Gara-Dorta/check-docs-are-updated
Check docs are updated
2026-05-19 13:34:19 +00:00 · 2026-05-17 22:24:27 +02:00 · 2026-05-17 22:24:09 +02:00 · 2026-05-15 19:50:35 +02:00 · 2026-05-15 19:47:51 +02:00 · 2026-05-15 19:41:52 +02:00
4 changed files with 47 additions and 5 deletions
--- a/.github/workflows/check-docs.yml
+++ 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
--- a/.github/workflows/ci.yml
+++ b/.github/workflows/ci.yml
@ -8,6 +8,8 @@ on:
    branches:
      - '**' #every branch

+permissions: {}
+
 jobs:
  setup:
    runs-on: ubuntu-24.04
@ -25,7 +27,7 @@ jobs:
    runs-on: ubuntu-24.04
    needs: setup
    steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          ref: ${{ github.ref }}
      - name: Login to Docker Hub
--- a/.github/workflows/release-dev-version.yml
+++ b/.github/workflows/release-dev-version.yml
@ -7,10 +7,16 @@ on:
        description: 'Version'
        required: true

+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
@ -24,7 +30,7 @@ jobs:
    runs-on: ubuntu-24.04
    needs: setup
    steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          ref: ${{ github.ref }}
      - name: Login to Docker Hub
--- a/.github/workflows/release-productive-version.yml
+++ b/.github/workflows/release-productive-version.yml
@ -7,10 +7,16 @@ on:
        description: 'Version'
        required: true

+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
@ -24,7 +30,7 @@ jobs:
    runs-on: ubuntu-24.04
    needs: setup
    steps:
-      - uses: actions/checkout@master
+      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          ref: ${{ github.ref }}
      - name: Login to Docker Hub
Author	SHA1	Message	Date
Gara Dorta	d52b6ef569	Merge 6e1698e8200a2ffdc41f59b9e7bb16caa7ad60c4 into ad5d3b76dbf87f601e1e9cbfa998a114a54a1c75	2026-05-17 22:24:27 +02:00
Bernhard B.	ad5d3b76db	Merge pull request #849 from Gara-Dorta/check-docs-are-updated Check docs are updated	2026-05-17 22:24:09 +02:00
Gara Dorta	0aaab36e5f	Enable read of repo	2026-05-15 19:50:35 +02:00
Gara Dorta	44ac16d49c	check docs before a release	2026-05-15 19:47:51 +02:00
Gara Dorta	e8c8b54d52	Merge branch 'master' into check-docs-are-updated	2026-05-15 19:41:52 +02:00
Bernhard B.	db63fd15e0	Merge pull request #848 from arnehuang/add-permissions-block Add empty permissions block at workflow level	2026-05-10 23:03:19 +02:00
Bernhard B.	650367e88a	Merge pull request #847 from arnehuang/pin-actions-checkout-sha Pin actions/checkout to a commit SHA	2026-05-10 23:02:13 +02:00
Arne Huang	69457e8f81	Add empty permissions block at workflow level Caps GITHUB_TOKEN's blast radius. None of these workflows need any GitHub API write scope — they only push to Docker Hub — so the safest default is permissions: {}, matching the posture used by AsamK/signal-cli. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>	2026-05-09 10:00:28 -07:00
Arne Huang	2e8171d84c	Pin actions/checkout to a commit SHA Follow-up to #838: actions/checkout was the only third-party action left on a mutable ref (@master). Pin it to v6.0.2's commit SHA, matching the pattern used for docker/setup-qemu-action, docker/setup-buildx-action, and docker/login-action. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>	2026-05-09 09:56:36 -07:00
Gara Dorta	16c3214862	Add update docs ci	2026-05-06 12:40:34 +01:00