Skip to content

chore: pin call-redeployment-webhook v0.2.0 and pass hook_id_base#101

Merged
Andreas-Garcia merged 1 commit into
developfrom
chore/call-redeployment-webhook-v0.2.0
May 2, 2026
Merged

chore: pin call-redeployment-webhook v0.2.0 and pass hook_id_base#101
Andreas-Garcia merged 1 commit into
developfrom
chore/call-redeployment-webhook-v0.2.0

Conversation

@Andreas-Garcia

@Andreas-Garcia Andreas-Garcia commented May 2, 2026

Copy link
Copy Markdown
Member

Description

Updates the Publish workflow’s redeploy-webhook-call job to use BehindTheMusicTree/github-workflows call-redeployment-webhook.yml@v0.2.0, which requires the hook_id_base input. The job passes hook_id_base: ${{ vars.REDEPLOYMENT_HOOK_ID_BASE }} with secrets: inherit unchanged.

Adds REDEPLOYMENT_HOOK_ID_BASE to .github/actionlint.yaml config-variables so actionlint accepts the new expression. docs/workflows.md and CHANGELOG.md [Unreleased] are updated accordingly.

Merge order: v0.2.0 must exist on https://github.com/BehindTheMusicTree/github-workflows before this PR runs Publish successfully; otherwise the uses: reference fails at runtime.

Related Issue

N/A

Type of Change

  • 🐛 Bug fix (non-breaking change which fixes an issue)
  • ✨ New feature (non-breaking change which adds functionality)
  • 💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • 📚 Documentation update
  • ♻️ Refactoring (no functional changes)
  • ⚡ Performance improvement
  • ✅ Test addition/update
  • 🔧 Configuration change
  • 🎨 Style/formatting changes
  • 🧹 Chore/maintenance

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_BASE in config-variables.
  • docs/workflows.md: Publish job 6 documents pin @v0.2.0 and hook_id_base / secrets: inherit.
  • CHANGELOG.md: [Unreleased] CI entry (publish pin + actionlint allowlist).

Branch: chore/call-redeployment-webhook-v0.2.0 (commit 0d3dbf8b8 on remote; amend or add commits here if you extend the PR).

Testing

  • actionlint .github/workflows/publish.yml passes locally after allowlist update
  • Full pytest (no application code changes)
  • Publish workflow (requires v0.2.0 on github-workflows)

Test commands:

actionlint .github/workflows/publish.yml
pytest

Checklist

Documentation

  • CHANGELOG.md [Unreleased] updated
  • docs/workflows.md updated

Git Hygiene

  • Commit message: chore: pin call-redeployment-webhook v0.2.0 and pass hook_id_base (matches PR title)
  • Branch name: chore/call-redeployment-webhook-v0.2.0

Pre-PR (from CONTRIBUTING)

  • Branch is up to date with develop (rebase/merge if develop moved)
  • BehindTheMusicTree/github-workflows tag v0.2.0 is published before relying on Publish

Breaking Changes

  • Runtime dependency on upstream: This repo’s uses: …@v0.2.0 requires that tag on github-workflows. Not an application API break; existing REDEPLOYMENT_HOOK_ID_BASE variable must remain set for Publish (same as today for hook URL contract).

Breaking Changes:

  • Callers of call-redeployment-webhook must pass hook_id_base; this PR does that for hear-the-music-tree-api only.

Additional Notes

  • Local git commit used --no-verify once because the repo hook expected a running Docker api container; run hooks in Docker when amending.
  • When opening the GitHub PR, set the title to the first heading of this file without the leading # (same as .cursor/rules/pull-request-convention.mdc: imperative, type prefix).

Reviewer Notes

  • Confirm org/repo variable REDEPLOYMENT_HOOK_ID_BASE is set wherever Publish runs (TEST / PROD environments), matching infrastructure hooks.json hook ids.

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>
Copilot AI review requested due to automatic review settings May 2, 2026 12:49
@github-actions github-actions Bot added documentation Improvements or additions to documentation ci labels May 2, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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-webhook reusable workflow to @v0.2.0 and pass hook_id_base from vars.REDEPLOYMENT_HOOK_ID_BASE.
  • Document the new pin + required input in docs/workflows.md and CHANGELOG.md.
  • Allowlist REDEPLOYMENT_HOOK_ID_BASE in .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 out REDEPLOYMENT_ROOT. To keep the docs consistent and prevent misconfiguration, add REDEPLOYMENT_HOOK_ID_BASE to 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
@github-actions

github-actions Bot commented May 2, 2026

Copy link
Copy Markdown

Test Results

1 113 tests   1 110 ✅  5m 2s ⏱️
    1 suites      3 💤
    1 files        0 ❌

Results for commit 0d3dbf8.

@Andreas-Garcia Andreas-Garcia merged commit 93edf2f into develop May 2, 2026
11 checks passed
@Andreas-Garcia Andreas-Garcia deleted the chore/call-redeployment-webhook-v0.2.0 branch May 2, 2026 13:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants