docs: require k8s-bake v4.1.1+ in the bake example - #555
Merged
David Gamero (davidgamero) merged 1 commit intoAug 11, 2026
Conversation
The bake example paired azure/k8s-bake@v3 with Azure/k8s-deploy@v7, which cannot work. Since v7, assertPathWithinWorkspace rejects manifests that resolve outside GITHUB_WORKSPACE, and k8s-bake before v4.1.1 wrote the baked manifest to RUNNER_TEMP, a sibling of the workspace on hosted runners. Copying the documented example produced: manifest path /home/runner/work/_temp/baked-template-<ts>.yaml resolves to ..., which is outside the workspace /home/runner/work/repo/repo k8s-bake v4.1.1 writes into $GITHUB_WORKSPACE/.k8s-bake/ instead (Azure/k8s-bake#289), so the chain works again with no change on the k8s-deploy side. Bump the example to @v4 and state the minimum version, since nothing in this repo currently tells users the bake upgrade is the fix. Refs Azure#553
David Gamero (davidgamero)
approved these changes
Aug 11, 2026
Collaborator
|
lgtm |
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.
Problem
The "Use bake action to get manifests" example pairs
azure/k8s-bake@v3withAzure/k8s-deploy@v7. That combination cannot work.Since v7,
assertPathWithinWorkspace(#528) rejectsmanifests:paths resolving outsideGITHUB_WORKSPACE.k8s-bakebefore v4.1.1 wrote the baked manifest toRUNNER_TEMP, which is a sibling of the workspace on hosted runners:So copying the documented example fails with:
Fix
k8s-bakev4.1.1 writes to$GITHUB_WORKSPACE/.k8s-bake/instead (Azure/k8s-bake#289), so the chain works again with no change needed on thek8s-deployside — the workspace confinement is working as designed.This PR only fixes the documentation:
@v3→@v4The gap this closes: nothing in this repo currently tells users that a
k8s-bakeupgrade is the remedy. The v7.0.0 changelog entry describes the confinement but never mentions the bake version requirement, so anyone onk8s-bake@v3orv4.1.0has no signal pointing at the fix.Fixes #553.
#553 had two halves. The runtime failure is already fixed upstream by
Azure/k8s-bake#289 (released in bake v4.1.1) — no code change is
needed here, since the workspace confinement is working as designed. The remaining half was
documentation: this repo still shipped the failing example and gave no indication that a
k8s-bakeupgrade was the remedy. This PR closes that half, so #553 can close when it merges.
Test plan
prettier --check README.mdpassesassertPathWithinWorkspaceis still present insrc/utilities/fileUtils.tsonmain(behavior intentionally unchanged)k8s-bakemainwrites to$GITHUB_WORKSPACE/.k8s-bake/viagetBakedManifestPath()