Skip to content

release: v1.2.4 - #151

Merged
dgates82 merged 13 commits into
mainfrom
release/1.2.4
Sep 21, 2026
Merged

dgates82 merged 13 commits into
mainfrom
release/1.2.4

Conversation

@dgates82

Copy link
Copy Markdown
Owner

Summary

  • Moves deploy-cloudrun.yml's GCP project/region/service/repository and Workload Identity Federation values from hardcoded to Actions variables (GCP_PROJECT_ID, GCP_REGION, CLOUD_RUN_SERVICE, ARTIFACT_REGISTRY_REPOSITORY, WORKLOAD_IDENTITY_PROVIDER, DEPLOY_SERVICE_ACCOUNT); the deploy job now skips cleanly when GCP_PROJECT_ID is unset instead of failing partway through
  • Makes the demo banner opt-in via DEMO_BANNER_ENABLED, and derives its repo link from github.repository instead of a hardcoded URL
  • Overhauls README.md as demo-first (live-demo callout, recorded auth-flow GIF, grouped feature list, package-ecosystem diagram); moves JWT/notification/database configuration, the customization table, and upgrade notes into docs/CONFIGURATION.md, docs/CUSTOMIZING.md, and docs/UPGRADING.md
  • Stamps CHANGELOG.md's [Unreleased] section as [1.2.4] - 2026-09-21

Test plan

deploy-cloudrun.yml's PROJECT_ID/REGION/SERVICE/REPOSITORY and the
auth step's workload_identity_provider/service_account now read from
six repo variables instead of being hardcoded. The deploy job gates
on GCP_PROJECT_ID being set, so a generated repo's tag push skips the
job cleanly instead of attempting anything. GCP's own Workload
Identity Federation trust (scoped to this exact repo) remains the
real, server-side backstop if someone points the variables at this
project's actual values from another repo.
…e docs

Moves auth before the Aiven power-on step so a misconfigured deploy
fails at the actual auth boundary instead of an unrelated Aiven
error first. Uses github.server_url/github.repository for the demo
banner's repo link instead of a hardcoded URL, so a generated repo's
deployment doesn't point back at the original. Moves the
TODO(template) marker next to the skip gate it explains, and stops
implying the six GCP/WIF variables alone are sufficient for a full
deploy. Documents that the demo banner is on by default for any
deployment using deploy-cloudrun.yml unmodified, correcting a false
claim that it was opt-in.
docs/DEPLOYMENT.md step 4 and the README's customization table row
now say the deploy job is skipped until GCP_PROJECT_ID is set, but
still needs all six GCP/WIF variables plus the Aiven and mock-URL
config to actually succeed, instead of implying six is sufficient.

Restores the TODO(template) marker on the Aiven power-on step,
dropped by mistake when consolidating the GCP/WIF markers into one -
it's a separate customization point unrelated to the skip gate and
needs to stay discoverable via git grep.

docs: DEPLOYMENT.md structure and CHANGELOG entry

Adds a Setup steps heading so the numbered steps aren't nested under
"Why a generated repo can't deploy," fixes a self-referential link,
and logs the demo banner URL fix under Unreleased.
Per David's decision on the open question in PR #148: the banner
was on by default for any deployment using deploy-cloudrun.yml
unmodified, which sat oddly next to this PR's goal of moving
repo-specific behavior into variables. It now reads
vars.DEMO_BANNER_ENABLED, defaulting to false.
The gate only checks GCP_PROJECT_ID, so the workflow comment and
CHANGELOG no longer imply the job skips until all six GCP/WIF
variables are set. Rewrites the muddled Demo banner paragraph in
docs/DEPLOYMENT.md and documents what it shows when the mock URLs
are unset (each link is independently omitted, no dead links). Lists
DEMO_BANNER_ENABLED in the step 5 variable checklist.
Drops the file-name reference and parenthetical detail, which would
go stale if the component is ever renamed.
ci: move Cloud Run deploy's GCP/WIF values to Actions variables
Restructures README.md around the live demo and a grouped feature list,
adds a package-ecosystem diagram and a recorded auth-flow GIF, and moves
JWT/notification/database configuration, the customization table, and
upgrade notes into docs/CONFIGURATION.md, docs/CUSTOMIZING.md, and
docs/UPGRADING.md. docs/LOCAL_DEV.md gains the native/hot-reload setup,
end-to-end suite instructions, and project structure previously in the
README. CONTRIBUTING.md and docs/DEPLOYMENT.md's cross-references are
updated to match.
Restores the Prerequisites and EF Core/MySQL facts dropped in the move to
docs/, adds the Jwt2Fa -> NotificationProviders edge to the ecosystem
diagram, links Deploy your own's step 6 to the variables it needs, marks
README.md itself as a TODO(template) customization point, fixes the demo
callout's doubled punctuation, updates the GIF alt text to match its
content, and trims a blank leading frame from the GIF.
Wraps the Angular client and .NET API in a labeled subgraph so the
diagram visually separates this repo from the extracted packages it
depends on.
docs: overhaul README as demo-first, move reference detail into docs/
@sonarqubecloud

Copy link
Copy Markdown

@dgates82
dgates82 merged commit f2ca5f1 into main Sep 21, 2026
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant