chore: pin call-redeployment-webhook v0.2.0 and pass hook_id_base#101
Merged
Merged
Conversation
Publish must pass required hook_id_base per BehindTheMusicTree/github-workflows v0.2.0; document in workflows.md, actionlint allowlist, and CHANGELOG [Unreleased]. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Publish GitHub Actions workflow to align with BehindTheMusicTree/github-workflows call-redeployment-webhook requirements by pinning the reusable workflow version and passing the newly required hook_id_base, with supporting documentation and lint config updates.
Changes:
- Pin
call-redeployment-webhookreusable workflow to@v0.2.0and passhook_id_basefromvars.REDEPLOYMENT_HOOK_ID_BASE. - Document the new pin + required input in
docs/workflows.mdandCHANGELOG.md. - Allowlist
REDEPLOYMENT_HOOK_ID_BASEin.github/actionlint.yaml.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/workflows.md | Documents the Publish workflow’s redeploy webhook call, including the new pinned version and required input. |
| CHANGELOG.md | Records the CI change under [Unreleased]. |
| .github/workflows/publish.yml | Pins call-redeployment-webhook to v0.2.0 and passes hook_id_base from repo/org vars. |
| .github/actionlint.yaml | Adds REDEPLOYMENT_HOOK_ID_BASE to actionlint’s allowed workflow variables list. |
Comments suppressed due to low confidence (1)
docs/workflows.md:65
- This section documents
hook_id_base: ${{ vars.REDEPLOYMENT_HOOK_ID_BASE }}, but the Publish workflow’s Variables section below only calls outREDEPLOYMENT_ROOT. To keep the docs consistent and prevent misconfiguration, addREDEPLOYMENT_HOOK_ID_BASEto the listed required Variables (and clarify whether it’s expected at org-level vs repo-level, and for which environments).
6. **redeploy-webhook-call** – shared workflow **`call-redeployment-webhook`** (pinned **`@v0.2.0`**) with required **`hook_id_base: ${{ vars.REDEPLOYMENT_HOOK_ID_BASE }}`** and **`secrets: inherit`**
**Environment:** **TEST** for main push and prerelease/dev tags (staging). **PROD** for release tags (production). DB and AFP image tags must be pinned in repo variables.
**Variables (org-level pool, same as Sync env):** `REDEPLOYMENT_ROOT` (e.g. `/var/webhook/redeployment`). Set once at the **organization** (Settings → Variables) so the infrastructure repo and all app repos that call set-image-tag-on-server use the same path. If unset, the tag file path is wrong and the step fails.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+162
to
166
| uses: BehindTheMusicTree/github-workflows/.github/workflows/call-redeployment-webhook.yml@v0.2.0 | ||
| with: | ||
| env: ${{ needs.determine-version.outputs.env }} | ||
| hook_id_base: ${{ vars.REDEPLOYMENT_HOOK_ID_BASE }} | ||
| secrets: inherit |
Test Results1 113 tests 1 110 ✅ 5m 2s ⏱️ Results for commit 0d3dbf8. |
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.
Description
Updates the Publish workflow’s
redeploy-webhook-calljob to use BehindTheMusicTree/github-workflowscall-redeployment-webhook.yml@v0.2.0, which requires thehook_id_baseinput. The job passeshook_id_base: ${{ vars.REDEPLOYMENT_HOOK_ID_BASE }}withsecrets: inheritunchanged.Adds
REDEPLOYMENT_HOOK_ID_BASEto.github/actionlint.yamlconfig-variablessoactionlintaccepts the new expression.docs/workflows.mdandCHANGELOG.md[Unreleased]are updated accordingly.Merge order:
v0.2.0must exist on https://github.com/BehindTheMusicTree/github-workflows before this PR runs Publish successfully; otherwise theuses:reference fails at runtime.Related Issue
N/A
Type of Change
Target Branch
develop(for features, bug fixes, chores, dependency updates from Dependabot)main(for hotfixes only)Changes Made
.github/workflows/publish.yml:call-redeployment-webhook@v0.1.5→@v0.2.0;with.hook_id_base: ${{ vars.REDEPLOYMENT_HOOK_ID_BASE }}..github/actionlint.yaml:REDEPLOYMENT_HOOK_ID_BASEinconfig-variables.docs/workflows.md: Publish job 6 documents pin@v0.2.0andhook_id_base/secrets: inherit.CHANGELOG.md:[Unreleased]CI entry (publish pin + actionlint allowlist).Branch:
chore/call-redeployment-webhook-v0.2.0(commit0d3dbf8b8on remote; amend or add commits here if you extend the PR).Testing
actionlint .github/workflows/publish.ymlpasses locally after allowlist updatepytest(no application code changes)v0.2.0on github-workflows)Test commands:
Checklist
Documentation
CHANGELOG.md[Unreleased]updateddocs/workflows.mdupdatedGit Hygiene
chore: pin call-redeployment-webhook v0.2.0 and pass hook_id_base(matches PR title)chore/call-redeployment-webhook-v0.2.0Pre-PR (from CONTRIBUTING)
develop(rebase/merge ifdevelopmoved)BehindTheMusicTree/github-workflowstagv0.2.0is published before relying on PublishBreaking Changes
uses: …@v0.2.0requires that tag on github-workflows. Not an application API break; existingREDEPLOYMENT_HOOK_ID_BASEvariable must remain set for Publish (same as today for hook URL contract).Breaking Changes:
call-redeployment-webhookmust passhook_id_base; this PR does that for hear-the-music-tree-api only.Additional Notes
git commitused--no-verifyonce because the repo hook expected a running Dockerapicontainer; run hooks in Docker when amending.#(same as.cursor/rules/pull-request-convention.mdc: imperative, type prefix).Reviewer Notes
REDEPLOYMENT_HOOK_ID_BASEis set wherever Publish runs (TEST / PROD environments), matching infrastructurehooks.jsonhook ids.