Skip to content

feat(#1177): add SchemaSpy workflow for postgres deployment model #1219

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Abradat wants to merge 10 commits into
base: main
Choose a base branch
from
+29 −0
Open

feat(#1177): add SchemaSpy workflow for postgres deployment model #1219

Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
ae5dbeb
feat: add SchemaSpy workflow for DB docs
Abradat Mar 6, 2026
0c153ae
feat: change main to feature branch to temporarily spin up the workflow
Abradat Mar 6, 2026
8499b98
feat: change schema-spy workflow name
Abradat Mar 6, 2026
d5a3691
chore: comment out the paths
Abradat Mar 6, 2026
46bebdb
chore: remove comments
Abradat Mar 6, 2026
45296ce
chore: add temporary whitespace to trigger schema spy pipeline
Abradat Mar 6, 2026
e591256
chore: remove redundant empty line after testing
Abradat Mar 6, 2026
f7bf93a
feat: change schema-spy workflow job name
Abradat Mar 6, 2026
b755118
feat: change schema-spy workflow target branch back to main after tes…
Abradat Mar 6, 2026
449c1fa
feat: add concurrency control on schema-spy workflow
Abradat Mar 6, 2026
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
29 changes: 29 additions & 0 deletions .github/workflows/schema-spy.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: SchemaSpy

concurrency:
group: ${{ github.workflow }}
cancel-in-progress: false

on:
push:
branches: [main]
paths:
- "backend/src/main/resources/db/migration/**"
- "backend/src/main/resources/db/migration-dev/**"
workflow_dispatch:

permissions: {}

jobs:
schemaspy:
name: Generate SchemaSpy Documentation and Push to GitHub Pages
permissions:
contents: write
pages: write
Comment on lines +21 to +22
Copy link

Copilot AI Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The job is intended to publish to GitHub Pages, but it only grants contents: write and pages: write. If the reusable SchemaSpy workflow uses the official GitHub Pages deployment flow (actions/deploy-pages), it also requires id-token: write (and the caller must grant it). Consider adding id-token: write here, and (if branch pushes aren’t required) reducing contents to read for least privilege.

Suggested change
contents: write
pages: write
contents: read
pages: write
id-token: write

Copilot uses AI. Check for mistakes.
uses: bcgov/quickstart-openshift-helpers/.github/workflows/.schema-spy.yml@ca6579bdadf383a2513397081f963889b92823a4 # v1.1.0
with:
flyway_locations: >-
filesystem:./backend/src/main/resources/db/migration,
filesystem:./backend/src/main/resources/db/migration-dev
Comment on lines +25 to +27
Copy link

Copilot AI Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

flyway_locations is defined as a folded scalar (>-) across two lines, which will insert a space after the comma in the final value. If the downstream workflow splits locations on commas without trimming, the second entry can end up with a leading space and be treated as an invalid location. Safer options are to put this on a single line or ensure entries are trimmed in the called workflow.

Suggested change
flyway_locations: >-
filesystem:./backend/src/main/resources/db/migration,
filesystem:./backend/src/main/resources/db/migration-dev
flyway_locations: filesystem:./backend/src/main/resources/db/migration,filesystem:./backend/src/main/resources/db/migration-dev

Copilot uses AI. Check for mistakes.
flyway_schema: silva
schemaspy_schema: silva
Loading