Add verification workflow for generated code and OpenAPI spec
All checks were successful
Test / test-frontend (pull_request) Successful in 24s
Test / frontend-build (pull_request) Successful in 24s
Verify / verify-generated-code (pull_request) Successful in 7m58s
Verify / verify-openapi-spec (pull_request) Successful in 1m12s
Test / test (pull_request) Successful in 1m12s
Test / lint (pull_request) Successful in 1m11s

This commit is contained in:
GW_MC
2025-12-05 19:00:04 +08:00
parent 81fbf8281f
commit 1c051f9502
2 changed files with 112 additions and 28 deletions

112
.github/workflows/verify.yml vendored Normal file
View File

@@ -0,0 +1,112 @@
# this workflow verifies the generated code is up to date and valid
name: Verify
on:
pull_request:
branches:
- master
push:
branches:
- master
jobs:
# setup is now handled by a composite action used by downstream jobs to keep
# the workflow DRY. The composite action performs checkout, cache restore and
# toolchain setup.
verify-generated-code:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Setup Rust, checkout and restore caches
uses: ./.github/actions/setup-rust
- name: generate entities from migration files
run: |
cd apps/cli
cargo run -- db:migrate_and_generate --output-path ../../public/database/src/generated/entities
- name: Check for uncommitted changes in /generated/
run: |
if [[ -n $(git status --porcelain | grep '^ M .*\/generated\/') ]]; then
echo "Generated code is not up to date. Please run the code generation locally and commit the changes."
git status --porcelain | grep '^ M .*\/generated\/'
exit 1
else
echo "Generated code is up to date."
fi
verify-openapi-spec:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Check whether apps/api/src/routes changed
id: check_changes
run: |
if [ "${{ github.event_name }}" = "pull_request" ]; then
BASE_SHA=${{ github.event.pull_request.base.sha }}
HEAD_SHA=${{ github.event.pull_request.head.sha }}
else
BASE_SHA=${{ github.event.before }}
HEAD_SHA=${{ github.sha }}
fi
# Provide safe fallbacks when GitHub context values are empty (e.g. when using act)
if [ -z "$HEAD_SHA" ]; then
HEAD_SHA=$(git rev-parse --verify HEAD 2>/dev/null || echo "")
fi
if [ -z "$BASE_SHA" ]; then
# Try the parent of HEAD, fall back to HEAD if unavailable
PREV=$(git rev-parse --verify "${HEAD_SHA}^" 2>/dev/null || true)
if [ -n "$PREV" ]; then
BASE_SHA=$PREV
else
BASE_SHA=$HEAD_SHA
fi
fi
echo "Comparing $BASE_SHA..$HEAD_SHA"
CHANGED_FILES=$(git diff --name-only "$BASE_SHA" "$HEAD_SHA" || true)
echo "$CHANGED_FILES"
echo "$CHANGED_FILES" | grep -E '^(apps/api/src/routes/?|apps/api/swagger.json)' >/dev/null 2>&1 && echo "changed=true" >> $GITHUB_OUTPUT || echo "changed=false" >> $GITHUB_OUTPUT
- name: Setup Rust, checkout and restore caches
if: steps.check_changes.outputs.changed == 'true'
uses: ./.github/actions/setup-rust
- name: Generate dummy frontend build (to satisfy dependencies)
if: steps.check_changes.outputs.changed == 'true'
run: |
mkdir -p apps/frontend/build/client
echo "dummy file" > apps/frontend/build/client/dummy.txt
- name: Generate OpenAPI spec
if: steps.check_changes.outputs.changed == 'true'
run: |
cd apps/api
cargo run -- generate:openapi --output-path ./swagger.json
- name: Check for uncommitted changes in swagger.json
if: steps.check_changes.outputs.changed == 'true'
run: |
if [[ -n $(git status --porcelain | grep '^ M apps/api/swagger.json') ]]; then
echo "OpenAPI spec is not up to date. Please run the OpenAPI generation locally and commit the changes."
git status --porcelain | grep '^ M apps/api/swagger.json'
exit 1
else
echo "OpenAPI spec is up to date."
fi
- name: Skip OpenAPI generation (no relevant changes)
if: steps.check_changes.outputs.changed == 'false'
run: echo "No changes in apps/api/src/routes/ nor apps/api/swagger.json, skipping OpenAPI generation verification."