Explicitly disable sparse checkout unless asked for #1598

dscho · 2024-01-31T14:00:22Z

When a worktree is reused by actions/checkout and the first time sparse checkout was enabled, we need to ensure that the second time it is only a sparse checkout if explicitly asked for. Otherwise we need to disable the sparse checkout so that a full checkout is the outcome of this Action.

This fixes #1475

This should allow users to reuse existing folders when running `actions/checkout` where a previous run asked for a sparse checkout but the current run does not ask for a sparse checkout. This fixes actions#1475 Signed-off-by: Johannes Schindelin <[email protected]>

Signed-off-by: Johannes Schindelin <[email protected]>

dscho · 2024-01-31T14:45:26Z

It looks as if the test-proxy job fails even without these here changes, so I'll call this PR good to go.

There are use cases in particular with non-ephemeral runners where an existing worktree (that has been initialized as a sparse checkout) is reused in subsequent CI runs (where `actions/checkout` is run _without_ any `sparse-checkout` parameter). In these scenarios, we need to make sure that the sparse checkout is disabled before checking out the files. Signed-off-by: Johannes Schindelin <[email protected]>

jww3 · 2024-02-01T11:40:49Z

dist/index.js

+                yield git.disableSparseCheckout();
+            }
+            else {
                core.startGroup('Setting up sparse checkout');


do you want to pop the .startGroup / .endGroup calls outside of the if block?

Consider core.startGroup('Applying sparse checkout options');

No, because we're not actually setting up a sparse checkout. We're disabling it. But saying that would only make sense if there was a worktree already, otherwise there'd be no sparse checkout to disable.

Added a clarifying comment about test branches.

@fhammerl

Try pointing `test-proxy` at a custom container image `fdev321123/ubuntu-with-git` (courtesy of @fhammerl)

joshmgross · 2024-02-16T20:48:45Z

.github/workflows/test.yml

    runs-on: ubuntu-latest
    container:
-      image: alpine/git:latest
+      image: fdev321123/ubuntu-with-git:latest


We should be very careful about adding in external dependencies to our workflows - https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions

If this is something we internally built, could we publish it to ghcr.io within this repository or org?

Agreed. This was something @fhammerl provided as a proof-of-concept, but I was just reading up about how to publish packages to ghcr.io and like the idea of hosting this container image at ghcr.io/actions (see neighboring packages here)

source: https://git-scm.com/download/linux

dscho added 2 commits January 31, 2024 14:52

npm run build

c4cda12

Signed-off-by: Johannes Schindelin <[email protected]>

dscho force-pushed the explicitly-disable-sparse-checkout-unless-asked-for branch from 29f6b52 to 79dd834 Compare January 31, 2024 14:04

dscho mentioned this pull request Jan 31, 2024

ci: fix test-proxy #1599

Closed

dscho marked this pull request as ready for review January 31, 2024 14:45

dscho requested a review from a team as a code owner January 31, 2024 14:45

dscho force-pushed the explicitly-disable-sparse-checkout-unless-asked-for branch from 79dd834 to 6f108b2 Compare January 31, 2024 15:13

jww3 reviewed Feb 1, 2024

View reviewed changes

jww3 self-assigned this Feb 1, 2024

jww3 added 10 commits February 16, 2024 13:31

Prefer ubuntu over alpine in test-proxy workflow

6d74269

revert change to container image in test.yml

4dfc3ce

Bump actions/checkout version in test-proxy

463d088

prefer ununtu over alpine in test-proxy

ed56252

Temporarily disable failing test.

268a122

Added a clarifying comment about test branches.

Inspect git version during test-proxy

b300d42

fix order-of-operations in test.yml

9b4fb8b

Fix order-of-operations in test.yml

9397c07

Ensure test-proxy is using an up-to-date version of git

3940af5

Experiment on test-proxy

572f5de

Try pointing `test-proxy` at a custom container image `fdev321123/ubuntu-with-git` (courtesy of @fhammerl)

joshmgross reviewed Feb 16, 2024

View reviewed changes

jww3 added 8 commits February 17, 2024 00:48

Create ubuntu-with-git.Dockerfile

78c6190

Rename ubuntu-with-git.Dockerfile to Dockerfile

a48123a

Create ubuntu-with-git/action.yml

34a3ecd

Delete .github/ubuntu-with-git directory

6af92d2

Removed commented-out docker commands in test.yml

894f97f

Second attempt to install git via apt-get

996d145

Followed official guidance for installing git

87e9846

source: https://git-scm.com/download/linux

ensure software-properties-common is installed.

772739e

Trimell2006 mentioned this pull request Nov 17, 2024

chore(deps): Bump the all group across 1 directory with 4 updates puppeteer/replay#918

Closed

gesslar mentioned this pull request Mar 11, 2025

Bump actions/checkout from 3 to 4 gesslar/Oxidus#159

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Explicitly disable sparse checkout unless asked for #1598

Explicitly disable sparse checkout unless asked for #1598

dscho commented Jan 31, 2024 •

edited

Loading

Uh oh!

dscho commented Jan 31, 2024

Uh oh!

jww3 Feb 1, 2024 •

edited

Loading

Uh oh!

dscho Feb 1, 2024

Uh oh!

joshmgross Feb 16, 2024

Uh oh!

jww3 Feb 17, 2024

Uh oh!

Uh oh!

Explicitly disable sparse checkout unless asked for #1598

Explicitly disable sparse checkout unless asked for #1598

Conversation

dscho commented Jan 31, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dscho commented Jan 31, 2024

Uh oh!

jww3 Feb 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dscho Feb 1, 2024

Choose a reason for hiding this comment

Uh oh!

joshmgross Feb 16, 2024

Choose a reason for hiding this comment

Uh oh!

jww3 Feb 17, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

dscho commented Jan 31, 2024 •

edited

Loading

jww3 Feb 1, 2024 •

edited

Loading