Does checkout supports sparse-checkout #26578

fawazahmed0 · 2020-09-08T00:07:12Z

fawazahmed0
Sep 8, 2020

This will help in case of large repos, just wanted to know whether this is supported or not in checkout actions
We can combine this with clone --filter flag to clone only the files we want

Answered by kingthorin

Sep 8, 2020

You can specify fetch-depth, which might help:

GitHub

actions/checkout

Action for checking out a repo. Contribute to actions/checkout development by creating an account on GitHub.

It looks like there’s an open issue to support sparse checkout:

github.com/actions/checkout

Options like sparse mode

<div class="github-info">
  <div class="date">
    opened <span class="discourse-local-date" data-format="ll" data-date="2020-03-02" data-time="12:57:52" data-timezone="UTC">12:57PM - 02 Mar 20 UTC</span>
  </div>


  <div class="user">
    <a href="https://github.com/jjangga0214" target="_blank" rel="nofollow noopener">
      <img alt="jjangga0214" src="https://user-images.githubuser…

View full answer

kingthorin · 2020-09-08T00:30:29Z

kingthorin
Sep 8, 2020

You can specify fetch-depth, which might help:

GitHub

actions/checkout

Action for checking out a repo. Contribute to actions/checkout development by creating an account on GitHub.

It looks like there’s an open issue to support sparse checkout:

github.com/actions/checkout

Options like sparse mode

<div class="github-info">
  <div class="date">
    opened <span class="discourse-local-date" data-format="ll" data-date="2020-03-02" data-time="12:57:52" data-timezone="UTC">12:57PM - 02 Mar 20 UTC</span>
  </div>


  <div class="user">
    <a href="https://github.com/jjangga0214" target="_blank" rel="nofollow noopener">
      <img alt="jjangga0214" src="https://user-images.githubusercontent.com/7570458/181098545-108d8f69-781e-47b0-bb1d-0e24fbfeced0.png" class="onebox-avatar-inline" width="20" height="20">
      jjangga0214
    </a>
  </div>
</div>

Hi. GitHub is internally evaluating partial-clone (Actually GitLab already provides the feature!). This can be useful for a large monorepo with sparse-checkout(see git...

0 replies

fawazahmed0 · 2020-09-08T01:14:23Z

fawazahmed0
Sep 8, 2020
Author

I was just thinking of opening a new feature request , Thanks for point to the already open issue.

0 replies

fawazahmed0 · 2020-09-08T22:29:34Z

fawazahmed0
Sep 8, 2020
Author

This is what I did to get partial clone:

      - name: Partial Clone
        run: |
          REPO="https://${GITHUB_ACTOR}:${{ secrets.GITHUB_TOKEN }}@github.com/${GITHUB_REPOSITORY}.git"
          git config --global user.email github-actions@github.com
          git config --global user.name github-actions
          git clone --filter=blob:none --no-checkout --depth 1  --sparse $REPO .
          git sparse-checkout init --cone
          git sparse-checkout add "folder1" "folder2/folder3"
          git checkout

Hopefully should help someone trying to clone large repos

Refer this and this for more details

0 replies

steoj · 2021-04-22T08:06:24Z

steoj
Apr 22, 2021

This looks good, but I have not been able to decode the GITHUB_ACTOR and GITHUB_TOKEN. Are these personal or something to explicitly allow for my private repo?

0 replies

kingthorin · 2021-04-24T21:02:40Z

kingthorin
Apr 24, 2021

GITHUB_ACTOR is whoever is causing the action to run. (Ref: Environment variables - GitHub Docs)

GITHUB_TOKEN is a temporary token that’s generated for each action run. (Ref: Authentication in a workflow - GitHub Docs)

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

GitHub Community

Does checkout supports sparse-checkout #26578

{{title}}

Replies: 5 comments

{{title}}

Options like sparse mode

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

Does checkout supports sparse-checkout #26578

Replies: 5 comments

fawazahmed0 Sep 8, 2020 Author

fawazahmed0 Sep 8, 2020 Author

fawazahmed0
Sep 8, 2020
Author

fawazahmed0
Sep 8, 2020
Author