mirror of
https://github.com/bbernhard/signal-cli-rest-api.git
synced 2026-06-28 20:10:20 +00:00
38 lines
1.3 KiB
YAML
38 lines
1.3 KiB
YAML
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: Download and inject receive schemas
|
|
working-directory: src/docs
|
|
run: |
|
|
SIGNAL_CLI_VERSION="$(grep -m1 '^ARG SIGNAL_CLI_VERSION=' ../../Dockerfile | cut -d= -f2)"
|
|
curl -fsSL "https://github.com/Gara-Dorta/signal-cli/releases/download/v${SIGNAL_CLI_VERSION}/signal-cli-${SIGNAL_CLI_VERSION}-json-schemas.tar.gz" -o signal-cli-json-schemas.tar.gz
|
|
mkdir -p signal-cli-schemas
|
|
tar xf signal-cli-json-schemas.tar.gz -C signal-cli-schemas
|
|
go run add_v1_receive_schemas.go signal-cli-schemas
|
|
|
|
- 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
|