diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index fe2539f..3aa5fc9 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -165,22 +165,6 @@ jobs: - name: Verify submodules recursive run: __test__/verify-submodules-recursive.sh - # Worktree credentials - - name: Checkout for worktree test - uses: ./ - with: - path: worktree-test - - name: Verify worktree credentials - shell: bash - run: __test__/verify-worktree.sh worktree-test worktree-branch - - # Worktree credentials in container step - - name: Verify worktree credentials in container step - if: runner.os == 'Linux' - uses: docker://bitnami/git:latest - with: - args: bash __test__/verify-worktree.sh worktree-test container-worktree-branch - # Basic checkout using REST API - name: Remove basic if: runner.os != 'windows' diff --git a/CHANGELOG.md b/CHANGELOG.md index 6d5a6f3..25befb7 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,19 +1,19 @@ # Changelog -## v6.0.0 +## V6.0.0 * Persist creds to a separate file by @ericsciple in https://github.com/actions/checkout/pull/2286 * Update README to include Node.js 24 support details and requirements by @salmanmkc in https://github.com/actions/checkout/pull/2248 -## v5.0.1 +## V5.0.1 * Port v6 cleanup to v5 by @ericsciple in https://github.com/actions/checkout/pull/2301 -## v5.0.0 +## V5.0.0 * Update actions checkout to use node 24 by @salmanmkc in https://github.com/actions/checkout/pull/2226 -## v4.3.1 +## V4.3.1 * Port v6 cleanup to v4 by @ericsciple in https://github.com/actions/checkout/pull/2305 -## v4.3.0 +## V4.3.0 * docs: update README.md by @motss in https://github.com/actions/checkout/pull/1971 * Add internal repos for checking out multiple repositories by @mouismail in https://github.com/actions/checkout/pull/1977 * Documentation update - add recommended permissions to Readme by @benwells in https://github.com/actions/checkout/pull/2043 diff --git a/README.md b/README.md index f0f65f9..a8549c3 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,8 @@ ## What's new -- Improved credential security: `persist-credentials` now stores credentials in a separate file under `$RUNNER_TEMP` instead of directly in `.git/config` -- No workflow changes required — `git fetch`, `git push`, etc. continue to work automatically -- Running authenticated git commands from a [Docker container action](https://docs.github.com/actions/sharing-automations/creating-actions/creating-a-docker-container-action) requires Actions Runner [v2.329.0](https://github.com/actions/runner/releases/tag/v2.329.0) or later +- Updated `persist-credentials` to store the credentials under `$RUNNER_TEMP` instead of directly in the local git config. + - This requires a minimum Actions Runner version of [v2.329.0](https://github.com/actions/runner/releases/tag/v2.329.0) to access the persisted credentials for [Docker container action](https://docs.github.com/en/actions/tutorials/use-containerized-services/create-a-docker-container-action) scenarios. # Checkout v5 diff --git a/__test__/verify-worktree.sh b/__test__/verify-worktree.sh deleted file mode 100755 index 3a4d3e4..0000000 --- a/__test__/verify-worktree.sh +++ /dev/null @@ -1,51 +0,0 @@ -#!/bin/bash -set -e - -# Verify worktree credentials -# This test verifies that git credentials work in worktrees created after checkout -# Usage: verify-worktree.sh - -CHECKOUT_PATH="$1" -WORKTREE_NAME="$2" - -if [ -z "$CHECKOUT_PATH" ] || [ -z "$WORKTREE_NAME" ]; then - echo "Usage: verify-worktree.sh " - exit 1 -fi - -cd "$CHECKOUT_PATH" - -# Add safe directory for container environments -git config --global --add safe.directory "*" 2>/dev/null || true - -# Show the includeIf configuration -echo "Git config includeIf entries:" -git config --list --show-origin | grep -i include || true - -# Create the worktree -echo "Creating worktree..." -git worktree add "../$WORKTREE_NAME" HEAD --detach - -# Change to worktree directory -cd "../$WORKTREE_NAME" - -# Verify we're in a worktree -echo "Verifying worktree gitdir:" -cat .git - -# Verify credentials are available in worktree by checking extraheader is configured -echo "Checking credentials in worktree..." -if git config --list --show-origin | grep -q "extraheader"; then - echo "Credentials are configured in worktree" -else - echo "ERROR: Credentials are NOT configured in worktree" - echo "Full git config:" - git config --list --show-origin - exit 1 -fi - -# Verify fetch works in the worktree -echo "Fetching in worktree..." -git fetch origin - -echo "Worktree credentials test passed!" diff --git a/dist/index.js b/dist/index.js index b9b34d3..a251a19 100644 --- a/dist/index.js +++ b/dist/index.js @@ -412,9 +412,6 @@ class GitAuthHelper { // Configure host includeIf const hostIncludeKey = `includeIf.gitdir:${gitDir}.path`; yield this.git.config(hostIncludeKey, credentialsConfigPath); - // Configure host includeIf for worktrees - const hostWorktreeIncludeKey = `includeIf.gitdir:${gitDir}/worktrees/*.path`; - yield this.git.config(hostWorktreeIncludeKey, credentialsConfigPath); // Container git directory const workingDirectory = this.git.getWorkingDirectory(); const githubWorkspace = process.env['GITHUB_WORKSPACE']; @@ -427,9 +424,6 @@ class GitAuthHelper { // Configure container includeIf const containerIncludeKey = `includeIf.gitdir:${containerGitDir}.path`; yield this.git.config(containerIncludeKey, containerCredentialsPath); - // Configure container includeIf for worktrees - const containerWorktreeIncludeKey = `includeIf.gitdir:${containerGitDir}/worktrees/*.path`; - yield this.git.config(containerWorktreeIncludeKey, containerCredentialsPath); } }); } diff --git a/src/git-auth-helper.ts b/src/git-auth-helper.ts index e67db14..a1950a6 100644 --- a/src/git-auth-helper.ts +++ b/src/git-auth-helper.ts @@ -374,10 +374,6 @@ class GitAuthHelper { const hostIncludeKey = `includeIf.gitdir:${gitDir}.path` await this.git.config(hostIncludeKey, credentialsConfigPath) - // Configure host includeIf for worktrees - const hostWorktreeIncludeKey = `includeIf.gitdir:${gitDir}/worktrees/*.path` - await this.git.config(hostWorktreeIncludeKey, credentialsConfigPath) - // Container git directory const workingDirectory = this.git.getWorkingDirectory() const githubWorkspace = process.env['GITHUB_WORKSPACE'] @@ -399,13 +395,6 @@ class GitAuthHelper { // Configure container includeIf const containerIncludeKey = `includeIf.gitdir:${containerGitDir}.path` await this.git.config(containerIncludeKey, containerCredentialsPath) - - // Configure container includeIf for worktrees - const containerWorktreeIncludeKey = `includeIf.gitdir:${containerGitDir}/worktrees/*.path` - await this.git.config( - containerWorktreeIncludeKey, - containerCredentialsPath - ) } }