Skip to content

docs: note persist-credentials requirement for actions/checkout@v6#361

Open
postalservice14 wants to merge 1 commit into
anothrNick:masterfrom
postalservice14:docs/checkout-v6-persist-credentials
Open

docs: note persist-credentials requirement for actions/checkout@v6#361
postalservice14 wants to merge 1 commit into
anothrNick:masterfrom
postalservice14:docs/checkout-v6-persist-credentials

Conversation

@postalservice14

Copy link
Copy Markdown

Summary of changes

actions/checkout@v6 changed how it stores the credentials it persists: they now
live under $RUNNER_TEMP instead of the local git config. A Docker container action
like this one cannot read them by default, so git push-based tagging fails with:

fatal: could not read Username for 'https://github.com/': No such device or address

This adds a README note under the existing fetch-depth note explaining the fix:
set persist-credentials: true (with an Actions runner ≥ v2.329.0), or rely on
the default GIT_API_TAGGING: true so tags are pushed via the GitHub API instead of
git 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.sh or action.yml.

How changes have been tested

List any unknowns

  • None. If maintainers prefer, the note could also be inlined as a comment in the
    example workflows in the README rather than (or in addition to) the standalone note.

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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant