[FEATURE] Trigger docs production build on overture-schema release - #690
Open
John McCall (lowlydba) wants to merge 10 commits into
Open
[FEATURE] Trigger docs production build on overture-schema release#690John McCall (lowlydba) wants to merge 10 commits into
John McCall (lowlydba) wants to merge 10 commits into
Conversation
Adds docs-publish.yml: fires on release: published, filtered to the overture-schema umbrella package's release (matching the same special-case release-trigger.yaml already makes for it), and dispatches production_deploy_documentation.yml on OvertureMaps/docs with the release's vanity tag as schema-ref (falling back to the package-prefixed tag if the vanity tag is ever missing). Cross-repo dispatch needs a token scoped to actions: write on OvertureMaps/docs, which no existing app provides (overture-release-publisher, #637, is contents: write on this repo only). Filed #689 to provision a new overture-docs-publisher app and its two secrets; the workflow references that issue and won't function until it's done. Also notes the new trigger in docs/versioning.md's release flow diagram. Refs #679, #689 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
John McCall (lowlydba)
temporarily deployed
to
staging
August 24, 2026 16:45 — with 
GitHub Actions
Inactive
GitHub Actions
Inactive
🗺️ Schema reference docs preview is live!
Note ♻️ This preview updates automatically with each push to this PR. |
This was referenced Aug 24, 2026
Per direction: extend the existing overture-releaser app (already used by release-trigger.yaml) with actions: write and install it on OvertureMaps/docs, rather than filing for a brand-new app. docs-publish.yml now fetches the same AWS Secrets Manager PEM via the same gha-releaser-secrets-reader OIDC role and client ID release-trigger.yaml uses, just scoping the minted token to permission-actions instead of permission-contents. Refs #679, #689 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
John McCall (lowlydba)
temporarily deployed
to
staging
August 24, 2026 16:52 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
release: doesn't support a tag-pattern filter (only push/create do), so filtering required a job-level if condition plus an API lookup to resolve the vanity tag as schema-ref. Triggering off push: tags: ['v*'] instead makes the tag glob itself the filter (only overture-schema's release creates a bare v* tag) and github.ref_name is the vanity tag directly, no lookup step needed. Tradeoff, documented in the workflow: if create-package-release ever skips the vanity tag because it already exists, no push fires and the docs rebuild silently doesn't dispatch for that release. Accepted per explicit direction in favor of the simpler workflow. Refs #679, #689 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
John McCall (lowlydba)
temporarily deployed
to
staging
August 24, 2026 16:59 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
The workflow's header comment covered the trigger mechanics, the vanity-tag edge case, and the overture-releaser reuse rationale in one long block. Trimmed it to a few lines pointing at docs/versioning.md's Cut a release section, which now spells all of that out where a reader is more likely to look for it alongside the rest of the release flow. Refs #679, #689 Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
John McCall (lowlydba)
temporarily deployed
to
staging
August 24, 2026 17:06 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
…visioning mechanics) Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
John McCall (lowlydba)
temporarily deployed
to
staging
August 24, 2026 17:34 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
John McCall (lowlydba)
requested review from
Dana Bauer (danabauer),
Seth Fitzsimmons (sethfitz) and
Victor Schappert (vcschapp)
August 24, 2026 17:36
John McCall (lowlydba)
marked this pull request as ready for review
August 24, 2026 17:37
Contributor
There was a problem hiding this comment.
Pull request overview
Adds an automated cross-repo trigger so the OvertureMaps/docs production documentation build runs when the overture-schema umbrella package publishes its bare v* vanity tag, keeping generated schema references aligned with released schema versions.
Changes:
- Add
docs-publish.ymlGitHub Actions workflow that dispatches the docs repo production deploy workflow onpushofv*tags. - Update
docs/versioning.mdrelease flow documentation and diagram to include the new docs rebuild trigger.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/versioning.md | Documents the new release-trigger → docs rebuild path and updates the mermaid flow diagram. |
| .github/workflows/docs-publish.yml | New workflow that listens for v* tag pushes and dispatches the docs production deploy workflow using a GitHub App token. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
John McCall (lowlydba)
temporarily deployed
to
staging
August 24, 2026 17:43 — with
GitHub Actions
Inactive
GitHub Actions
Inactive
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com> Signed-off-by: John McCall <john@overturemaps.org>
Alex Iannicelli (atiannicelli)
approved these changes
Aug 24, 2026
Alex Iannicelli (atiannicelli)
left a comment
Alex Iannicelli (atiannicelli)
left a comment
Contributor
There was a problem hiding this comment.
one nit
Seth Fitzsimmons (sethfitz)
approved these changes
Aug 24, 2026
Collaborator
|
Dana Bauer (@danabauer) to check in w John McCall (@lowlydba) on the plan here. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds
docs-publish.yml: fires onpush: tags: ['v*'], the bare vanity tagcreate-package-releasecreates only for theoverture-schemaumbrella package's release (see docs/versioning.md's tag scheme). No other package's release creates av*tag, so the glob is the entire filter, andgithub.ref_nameis the vanity tag itself, used directly asschema-refwith no lookup needed. (release: publisheddoesn't support a tag-pattern filter, onlypush/createdo, which is why this dispatches off the tag push rather than the release event.)Cross-repo dispatch uses the
overture-releaserapp (#637), the same apprelease-trigger.yamlalready uses.Also notes the new trigger in
docs/versioning.md's release flow diagram.Note
Docs-side work (the
schema-refinput onproduction_deploy_documentation.yml) is happening in parallel on OvertureMaps/docs, OvertureMaps/docs#493.Closes #691, a sub-issue of #679 scoped to this repo's half of the work.
Refs #689, OvertureMaps/docs#493