ci: upgrade to github-workflows v2.0.0 (set-image-tags, sync-env pin) by Andreas-Garcia · Pull Request #110 · BehindTheMusicTree/hear-the-music-tree-api

Andreas-Garcia · 2026-05-07T16:10:23Z

Description

Upgrades both publish and sync-env workflows to BehindTheMusicTree/github-workflows@v2.0.0, adopting the new atomic set-image-tags-on-server workflow and removing the obsolete REDEPLOYMENT_ROOT variable.

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

Replaced three separate set-image-tag-on-server.yml@main calls (API, DB, AFP) with a single set-image-tags-on-server.yml@v2.0.0 job using stack: btmt and a multiline tags block (HTMT_API_TAG, DB_TAG=16.4, AFP_TAG) plus release_id / release_sha metadata
check-pinned-tags: replaced REDEPLOYMENT_ROOT, HTMT_API_APP_NAME, DB_APP_NAME_SUFFIX, AFP_APP_NAME env/validation with IMAGE_TAGS_POOL_DIR
redeploy-webhook-call: pinned from @v1.0.4 → @v2.0.0; depends on set-image-tags instead of the three old jobs

.github/workflows/sync-env-to-server.yml

Removed REDEPLOYMENT_ROOT from both fragment-building job env blocks and required var checks (no longer a workflow_call input in v2.0.0)
Pinned all four shared workflow calls from @main → @v2.0.0

Testing

All existing tests pass
New tests added (if applicable)
Manual testing completed (if applicable)

Publish workflow triggered on a prerelease tag — set-image-tags job wrote btmt-staging.tags.env on the server successfully after manually creating IMAGE_TAGS_POOL_DIR (mkdir -p /srv/btmt/image-tags).

Test commands:

# No automated tests for workflow changes — validate via GitHub Actions run

Checklist

Code Quality

No debug statements or commented-out code

Tests

All tests pass: pytest

Documentation

CHANGELOG.md updated in [Unreleased] section

Git Hygiene

Commit messages follow convention: <type>(<scope>): <summary>
Branch is up to date with target branch
Branch follows naming convention (feature/, chore/, dependabot/, hotfix/, release/)
No accidental commits (large files, secrets, personal configs)

Breaking Changes

This PR includes breaking changes

Breaking Changes:

REDEPLOYMENT_ROOT GitHub Variable is no longer used and should be removed from STAGING/PROD environments
AFP_APP_NAME GitHub Variable is no longer used by publish.yml and can be removed
IMAGE_TAGS_POOL_DIR (e.g. /srv/btmt/image-tags) must be added to STAGING and PROD GitHub Environments before merging
The directory IMAGE_TAGS_POOL_DIR must exist on the server (mkdir -p /srv/btmt/image-tags)

Additional Notes

The v2.0.0 set-image-tags-on-server workflow writes a single atomic manifest file per stack/env (<stack>-<env>.tags.env) rather than one file per service, aligning with how the infrastructure redeploy script reads image tags.

…ariable, and update related scripts

Copilot

Pull request overview

This PR upgrades the repository’s GitHub Actions integrations to BehindTheMusicTree/github-workflows@v2.0.0, removes the legacy REDEPLOYMENT_ROOT variable in favor of the new image-tag pool directory variable, and updates the release tooling/docs accordingly.

Changes:

Update publish.yml to use set-image-tags-on-server.yml@v2.0.0 (single call for API/DB/AFP tags) and pin redeploy webhook to @v2.0.0; replace REDEPLOYMENT_ROOT with IMAGE_TAGS_POOL_DIR.
Update sync-env-to-server.yml to pin the shared workflow to @v2.0.0 and remove REDEPLOYMENT_ROOT from fragment-building validation.
Update release tooling to automatically remove prerelease/dev tags after bumping, and document workflow changes in the changelog/docs.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
`scripts/prepare_release_bump.py`	Adds a post-bump step to run `remove_prerelease_tags.sh`.
`docs/workflows.md`	Removes `REDEPLOYMENT_ROOT` mention in sync/publish documentation (but needs further updates for publish section accuracy).
`CHANGELOG.md`	Records the workflow v2.0.0 upgrade and release-script change under Unreleased.
`.github/workflows/sync-env-to-server.yml`	Removes `REDEPLOYMENT_ROOT` from required vars and pins reusable workflow calls to `@v2.0.0`.
`.github/workflows/publish.yml`	Switches from per-app tag setting to a single stack-based image-tag setting call; replaces `REDEPLOYMENT_ROOT` with `IMAGE_TAGS_POOL_DIR`; pins redeploy workflow to v2.0.0.
`.github/actionlint.yaml`	Removes `REDEPLOYMENT_ROOT` from the actionlint allowlist (but needs `IMAGE_TAGS_POOL_DIR` added).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  - GHCR_IMAGE_NAMESPACE
  - HTMT_API_IMAGE_REPO
  - AFP_VERSION
  - STATIC_FILES
  - STATIC_FILES_URL
  - SERVER_HOST
-  - REDEPLOYMENT_ROOT
  - BTMT_REDEPLOYMENT_HOOK_ID_BASE
  - DEMO_EMAIL


Andreas-Garcia · 2026-05-07T16:18:19Z

 1. **determine-version** – from ref: tag with `-` → TEST; tag without `-` → PROD; `main` (e.g. manual dispatch) → staging + TEST
 2. **static** – calls `static-files.yml`, commits and pushes collected static files
 3. **build-and-push** – calls `build-and-push.yml` with commit hash and **environment** (TEST or PROD)
 4. **check-pinned-tags** – requires **`AFP_VERSION`** in Settings → Variables (no `latest`); DB image is **`postgres:16.4`** (fixed in [`docker-compose.yml`](../docker-compose.yml); publish sets server DB tag **`16.4`**)
 5. **set-version-api** / **set-version-db** / **set-version-afp** – shared workflows from `BehindTheMusicTree/github-workflows`
 6. **redeploy-webhook-call** – **`hook_id_base`** from **`check-pinned-tags`** (**`BTMT_REDEPLOYMENT_HOOK_ID_BASE`** validated under **Environment** **`STAGING`** / **`PROD`** there). Caller job is **`uses:`** only—**`environment`** is not allowed on that job shape in the Actions schema, so **`secrets: inherit`** supplies **repo/org** secrets (e.g. **`BTMT_REDEPLOYMENT_WEBHOOK_SECRET_*`**). Environment-only webhook secrets need a repo/org copy or support inside **`call-redeployment-webhook`**. Pinned **`@v1.0.4`**.

 **Environment:** **TEST** for prerelease/dev tags and for manual runs from `main` (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.
-
 **Versioning:** Manual dispatch from `main` uses `VERSION` file and image tag `staging`. Tag push uses tag version; `workflow_call` without a tag uses latest git tag.


@copilot apply changes based on this feedback

Applied in commit 84b9035. I updated docs/workflows.md so the Publish section now matches publish.yml (uses set-image-tags, call-redeployment-webhook@v2.0.0, and includes IMAGE_TAGS_POOL_DIR as a required STAGING/PROD environment variable).

Agent-Logs-Url: https://github.com/BehindTheMusicTree/hear-the-music-tree-api/sessions/e800fbc0-4b36-4016-8020-b7510ca99b84 Co-authored-by: Andreas-Garcia <5967215+Andreas-Garcia@users.noreply.github.com>

Copilot · 2026-05-07T16:24:23Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

github-actions · 2026-05-07T16:39:28Z

Test Results

1 113 tests 1 109 ✅ 10m 40s ⏱️
1 suites 4 💤
1 files 0 ❌

Results for commit 84b9035.

chore: upgrade GitHub workflows to v2.0.0, remove REDEPLOYMENT_ROOT v…

c0a1117

…ariable, and update related scripts

Copilot AI review requested due to automatic review settings May 7, 2026 16:10

Andreas-Garcia temporarily deployed to ci_test May 7, 2026 16:10 — with GitHub Actions Inactive

Andreas-Garcia temporarily deployed to ci_test May 7, 2026 16:11 — with GitHub Actions Inactive

github-actions Bot added documentation Improvements or additions to documentation ci scripts labels May 7, 2026

Copilot started reviewing on behalf of Andreas-Garcia May 7, 2026 16:11 View session

Andreas-Garcia changed the title ~~chore: upgrade GitHub workflows to v2.0.0, remove REDEPLOYMENT_ROOT v…~~ ci: upgrade to github-workflows v2.0.0 (set-image-tags, sync-env pin) May 7, 2026

chore: add IMAGE_TAGS_POOL_DIR to config-variables in actionlint.yaml

8817d5d

Copilot AI reviewed May 7, 2026

View reviewed changes

Andreas-Garcia temporarily deployed to ci_test May 7, 2026 16:15 — with GitHub Actions Inactive

Andreas-Garcia temporarily deployed to ci_test May 7, 2026 16:16 — with GitHub Actions Inactive

Copilot started work on behalf of Andreas-Garcia May 7, 2026 16:18 View session

docs(workflows): sync publish job docs with v2 reusable workflows

84b9035

Agent-Logs-Url: https://github.com/BehindTheMusicTree/hear-the-music-tree-api/sessions/e800fbc0-4b36-4016-8020-b7510ca99b84 Co-authored-by: Andreas-Garcia <5967215+Andreas-Garcia@users.noreply.github.com>

Copilot finished work on behalf of Andreas-Garcia May 7, 2026 16:24

Copilot AI temporarily deployed to ci_test May 7, 2026 16:24 Inactive

Copilot AI temporarily deployed to ci_test May 7, 2026 16:25 Inactive

Andreas-Garcia merged commit 7e0ae93 into develop May 7, 2026
7 checks passed

Andreas-Garcia deleted the feature/upgrade-github-workflows branch May 7, 2026 16:41

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

ci: upgrade to github-workflows v2.0.0 (set-image-tags, sync-env pin)#110

ci: upgrade to github-workflows v2.0.0 (set-image-tags, sync-env pin)#110
Andreas-Garcia merged 3 commits into
developfrom
feature/upgrade-github-workflows

Andreas-Garcia commented May 7, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Andreas-Garcia May 7, 2026

Uh oh!

Copilot AI May 7, 2026

Uh oh!

Copilot AI commented May 7, 2026

Uh oh!

github-actions Bot commented May 7, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

Andreas-Garcia commented May 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related Issue

Type of Change

Target Branch

Changes Made

Testing

Checklist

Code Quality

Tests

Documentation

Git Hygiene

Breaking Changes

Additional Notes

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Andreas-Garcia May 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI May 7, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI commented May 7, 2026

Uh oh!

github-actions Bot commented May 7, 2026

Test Results

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Andreas-Garcia commented May 7, 2026 •

edited

Loading