docs: note persist-credentials requirement for actions/checkout@v6#361
Open
postalservice14 wants to merge 1 commit into
Open
docs: note persist-credentials requirement for actions/checkout@v6#361postalservice14 wants to merge 1 commit into
postalservice14 wants to merge 1 commit into
Conversation
actions/checkout@v6 persists the token under $RUNNER_TEMP instead of the local git config, which this Docker container action cannot read by default, causing 'could not read Username for https://github.com/'. Document the fix (persist-credentials: true with runner >= v2.329.0, or rely on the default GIT_API_TAGGING). Addresses anothrNick#350, anothrNick#352, anothrNick#358.
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
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.
Summary of changes
actions/checkout@v6changed how it stores the credentials it persists: they nowlive under
$RUNNER_TEMPinstead of the local git config. A Docker container actionlike this one cannot read them by default, so
git push-based tagging fails with:This adds a README note under the existing
fetch-depthnote explaining the fix:set
persist-credentials: true(with an Actions runner ≥ v2.329.0), or rely onthe default
GIT_API_TAGGING: trueso tags are pushed via the GitHub API instead ofgit push.This is the recurring cause behind #350, #352 and #358 — none of which are bugs in
the action itself, only a documentation gap.
Breaking Changes
Do any of the included changes break current behaviour or configuration?
NO — documentation only, no change to
entrypoint.shoraction.yml.How changes have been tested
actions/checkoutv6 release notes and the reproductions in actions/checkout v6 breaks GH API #352 / Different outcome depending on GIT_API_TAGGING is true of false #358.List any unknowns
example workflows in the README rather than (or in addition to) the standalone note.