refactor!: drop GitHub Deployments, rename annotations for Swarmia (CI-1229)#136
Open
0x46616c6b wants to merge 1 commit intomainfrom
Open
refactor!: drop GitHub Deployments, rename annotations for Swarmia (CI-1229)#1360x46616c6b wants to merge 1 commit intomainfrom
0x46616c6b wants to merge 1 commit intomainfrom
Conversation
…I-1229) Pivot away from GitHub Deployments (CI-1228): flux-deployment-reporter will now call the Swarmia Deployment API directly using metadata that this action stamps onto the Kustomization. Stop creating GitHub Deployment objects, drop the now-orphaned create-deployment and github-token inputs and the deployment-id output, rename the surviving annotations to match the Swarmia API field names, and add a version annotation carrying the deployed image tag. Annotation changes: deploy.staffbase.com/repo -> deploy.staffbase.com/repositoryFullName deploy.staffbase.com/sha -> deploy.staffbase.com/commitSha deploy.staffbase.com/deployment-id -> removed deploy.staffbase.com/version -> new (image tag) This is a breaking change to the action's public API and warrants a major version bump on release. Co-Authored-By: Claude <claude@anthropic.com>
flaxel
reviewed
May 5, 2026
Contributor
flaxel
left a comment
flaxel
left a comment
There was a problem hiding this comment.
I guess this change makes the action really Staffbase specific. Didn't we want to enable other peeps to use this functionality? 👀
flaxel
approved these changes
May 5, 2026
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
2 participants
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.
Type of Change
Description
Implements CI-1229 as part of the CI-1228 pivot away from GitHub Deployments toward the Swarmia Deployment API.
Why:
flux-deployment-reporterwill now call Swarmia directly when a Flux reconciliation completes, using metadata stamped onto the Kustomization by this action. GitHub Deployment objects, deployment statuses, and thedeployments: writepermission are no longer needed in the source repo.What changed:
The action no longer creates GitHub Deployment objects (the entire
actions/github-scriptstep is removed).Inputs
create-deploymentandgithub-tokenare removed; outputdeployment-idis removed.The annotation block is now unconditional — every file processed by the GitOps update step is stamped with deployment metadata. With
create-deploymentgone, gating it on a separate flag would just be ceremony.Annotation renames to align with Swarmia API field names:
deploy.staffbase.com/repodeploy.staffbase.com/repositoryFullNamedeploy.staffbase.com/shadeploy.staffbase.com/commitShadeploy.staffbase.com/deployment-idNew annotation
deploy.staffbase.com/versioncarrying the deployed image tag (dev-<short_sha>,main-<short_sha>/master-<short_sha>, or the tag name on tag pushes).Breaking change. The action's public API loses two inputs and one output, and the annotation keys written into the GitOps repo are renamed. Should be released as a major version bump (
v7.x→v8.0.0). Downstream consumers passingcreate-deploymentorgithub-tokenwill see the GitHub Actions "unexpected input" warning but will not fail. The companion change influx-deployment-reporter(CI-1228) needs to land in lockstep on the new annotation keys.Checklist
The changes and the PR were generated by Claude.