Skip to content

github: shallow-clone for actionlint and markdown check jobs #75

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

Merged
merged 1 commit into from
Apr 23, 2025

Conversation

ktdreyer
Copy link
Contributor

@ktdreyer ktdreyer commented Apr 22, 2025

For GitHub Actions that invoke setuptools-scm, we need the full Git history in order to get the proper versioning values from git describe (actions/checkout#249).

For GitHub Actions that do not invoke setuptools-scm, we do not need the full Git history, so we can speed up those clone operations with shallow clones.

Summary by Sourcery

CI:

  • Remove full Git history fetch (fetch-depth: 0) from actionlint and markdown check jobs to improve clone performance

For GitHub Actions that invoke setuptools-scm, we need the full Git
history in order to get the proper versioning values from "git
describe".

For GitHub Actions that do not invoke setuptools-scm, we do not need the
full Git history, so we can speed up those clone operations with
shallow clones.
Copy link
Contributor

sourcery-ai bot commented Apr 22, 2025

Reviewer's Guide by Sourcery

This pull request modifies the GitHub Actions workflows for actionlint and docs to remove the fetch-depth: 0 option from the checkout step. This ensures that the full Git history is available for these jobs, which is necessary for setuptools-scm to function correctly.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Removed the fetch-depth: 0 option from the actions/checkout step in the actionlint.yml workflow.
  • Removed fetch-depth: 0 from the checkout step.
.github/workflows/actionlint.yml
Removed the fetch-depth: 0 option from the actions/checkout step in the docs.yml workflow.
  • Removed fetch-depth: 0 from the checkout step.
.github/workflows/docs.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ktdreyer - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a comment to the workflow files explaining why fetch-depth: 0 was removed.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@ktdreyer
Copy link
Contributor Author

(sourcery-ai's statement is misleading: This ensures that the full Git history is available for these jobs, which is necessary for setuptools-scm to function correctly. It's the other way around: we don't need full Git history on actionlint.yml and docs.yml.)

@abhi1092
Copy link
Collaborator

@ktdreyer thanks for the feedback on Sourcery. We are testing its effectiveness for PR review process.

@abhi1092 abhi1092 merged commit e8306fd into Red-Hat-AI-Innovation-Team:main Apr 23, 2025
4 checks passed
shivchander pushed a commit that referenced this pull request Apr 28, 2025
For GitHub Actions that invoke setuptools-scm, we need the full Git
history in order to get the proper versioning values from "git
describe".

For GitHub Actions that do not invoke setuptools-scm, we do not need the
full Git history, so we can speed up those clone operations with
shallow clones.
@ktdreyer ktdreyer deleted the shallow-clone branch May 14, 2025 19:17
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.

2 participants