kustomize-everything/Kustomize Image and Helm Promotion

Promote a tagged image or helm chart to a deployment repo using Kustomize and Git

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Maintainedlast commit Nov 18, 2025
License
MIT

Pinned Snippet

workflow.ymlSHA-pinned
uses: kustomize-everything/action-promote@07fc52f2d12e5a4a13aece7811202dd56a7dba0d # v4.7.0

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
git-commit-userName to add to the Git Commit MessagenoKustomize Everything
git-commit-emailEmail to add to the Git Commit Messagenokustomize-everything@users.noreply.github.com
git-commit-messageCommit message to use for deploymentno
github-tokenGitHub token for either opening pull requests or fetching metadata about what is being promoted. yes
imagesA JSON list of images to promote. Each list item should be a dictionary with the following keys: - name: The name of the image in the target repository to update - newName: The image name to promote - newTag: The image tag to promote OR - fromOverlay: The name of the overlay to fetch the image details for the named image from - overlays: JSON list of overlays that this image should be promoted in Either images or helm-charts or both must be specified. []
chartsA JSON list of Helm charts to promote. Each list item should be a dictionary with the following keys: - name: The name of the chart in the target repository to update - releaseName: The name of the release to promote - version: The version of the chart to promote OR - fromOverlay: The name of the overlay to fetch the chart details for the named chart from - overlays: JSON list of overlays that this image should be promoted in Either images or helm-charts or both must be specified. []
promotion-methodHow to handle the promotion. pull_request opens a PR against the repository, ensures that all checks pass on the PR, and then self-merges the PR. push will push the changes directly to the target branch. nopush
status-attemptsThe number of times to attempt to check the status of the PR before giving up. no10
status-intervalThe number of seconds to wait between attempts to check the status of the PR. no30
auto-mergeToggles the behavior of automatically merging the PR when using the pull_request promotion method. If set to true, the PR will be automatically merged when all checks pass. If set to false, the PR will be opened but not merged. notrue
labelsComma separated list of labels to add to the PR. Only used when promotion method is pull_requets. no
sha256-checksumChecksum of Kustomize versionno3b30477a7ff4fb6547fa77d8117e66d995c2bdd526de0dafbf8b7bcb9556c85d
target-repoThe repo where the image promotion should be pushedyes
target-branchThe branch where the image promotion should be pushed (defaults to main) nomain
versionVersion of Kustomize to useno5.1.1
working-directoryWorking directory where the deployment repo should be checked out into noimage-promotion
dry-runIf true, the action will not actually do anything. This is useful for testing the action. false
debugIf true, the action will print out a lot of debug information. false
aggregate-pr-changesIf this is set to true, new changes will be aggregated in the existing open PRfalse
pr-reviewerReviewer for the PR""
pr-titleTitle of the PR. If unset a default title will be used""
pr-unique-keythis key will be added to all your PR branch names if "aggregate-pr-changes" is set to true80514bedee3628f200f6
namedescription
deployment-repo-shaGit SHA of promotion commit on deployment repo
deployment-repo-sha-urlGithub URL for the promotion commit on the deployment URL
deployment-repo-sha-shortGit short SHA of promotion commit on deployment repo.
images-updatedList of image name:tags that were promoted
pull-request-urlURL for the pull request created during promotion