Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Shallow clone variants #283

Merged
merged 3 commits into from Dec 7, 2023
Merged

Conversation

puerco
Copy link
Member

@puerco puerco commented Dec 7, 2023

What type of PR is this?

/kind feature

What this PR does / why we need it:

This PR adds Shallow* variants to our clone functions. These work exactly as their counterparts but perform a shallow (depth 1) clone of repositories to work with large repositories at HEAD more efficiently.

The new functions are:

  • git.ShallowCloneOrOpenRepo()
  • git.ShallowCloneOrOpenGitHubRepo()
  • git.ShallowCleanCloneGitHubRepo()

Note that this PR has many lines but at its core, it is the same logic just broken into ever more specific utility functions to reuse our code. The outward-facing functions just invoke the internal ones with a different options set. Roughly:

CleanCloneGitHubRepo
      |
  CloneOrOpenRepo
           \
         cloneOrOpenRepo  --- cloneRepository   
           /
  ShallowCloneOrOpenRepo
      |
ShallowCleanCloneGitHubRepo

Which issue(s) this PR fixes:

None

Special notes for your reviewer:

/assign @saschagrunert @cpanato @xmudrii

Does this PR introduce a user-facing change?

The `Clone*`  functions in the git package now have `Shallow*` variants that perform a shallow (depth 1) clone of the repo for more efficient copies of HEAD

This commit splits the CloneOrOpenRepo function to two utility functions
to avoid code duplication and expose the options of the clone call.

Signed-off-by: Adolfo García Veytia (Puerco) <adolfo.garcia@uservers.net>
@k8s-ci-robot k8s-ci-robot added the kind/feature Categorizes issue or PR as related to a new feature. label Dec 7, 2023
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Dec 7, 2023
@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. sig/release Categorizes an issue or PR as relevant to SIG Release. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Dec 7, 2023
@puerco
Copy link
Member Author

puerco commented Dec 7, 2023

mmmh 🤔
/test pull-release-sdk-integration-test

This commit split the core of the functionality of the CloneOrOpenRepo
to a utility function to make it reusable from functions requiring different
git options.

Signed-off-by: Adolfo García Veytia (Puerco) <adolfo.garcia@uservers.net>
This commit adds Shallow* variants to our clone functions. The goal
of these is to enable faster cloning of large repositories.

Signed-off-by: Adolfo García Veytia (Puerco) <adolfo.garcia@uservers.net>
@puerco
Copy link
Member Author

puerco commented Dec 7, 2023

Found the error. Thank you tests for doing your job 😸

Copy link
Member

@cpanato cpanato left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 7, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: cpanato, puerco

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit 7d858b3 into kubernetes-sigs:main Dec 7, 2023
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. sig/release Categorizes an issue or PR as relevant to SIG Release. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants