Skip to content

fix(ci): Checkout docs with Git-LFS (fixes #820). #821

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Apr 13, 2025
Merged

fix(ci): Checkout docs with Git-LFS (fixes #820). #821

merged 1 commit into from
Apr 13, 2025

Conversation

kirkrodrigues
Copy link
Member

@kirkrodrigues kirkrodrigues commented Apr 12, 2025 •
edited by coderabbitai bot
Loading

Description

This updates the clp-docs workflow to also checkout LFS files when checking out the repo.

Checklist

  • The PR satisfies the contribution guidelines.
  • This is a breaking change and that has been indicated in the PR title, OR this isn't a
    breaking change.
  • Necessary docs have been updated, OR no docs need to be updated.

Validation performed

Pushed this change to main in my fork and validated that the built artifact contained the images.

Summary by CodeRabbit

  • New Features
    • Enhanced support for handling large files during automated processes, ensuring smoother and more reliable operations.

@kirkrodrigues kirkrodrigues requested a review from a team as a code owner April 12, 2025 09:05
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 12, 2025 •
edited
Loading

Walkthrough

The pull request updates the GitHub Actions workflow by adding the lfs: "true" configuration option to the checkout step. This adjustment enables support for Git Large File Storage (LFS), allowing the workflow to handle large files more effectively during the checkout process.

Changes

File Change Summary
.github/workflows/clp-docs.yaml Added the lfs: "true" option in the checkout step to enable Git LFS support; no other changes

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot reviewed Apr 12, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
.github/workflows/clp-docs.yaml (2)

24-27: Enhancement: Git-LFS Checkout Enabled

The addition of lfs: "true" under the checkout step correctly enables Git-LFS support during repository cloning. This change ensures that large files managed by Git-LFS are selected in the built artifact, which aligns well with the PR objectives.

24-27: Consideration: Checkout Action Versioning

The checkout action is referenced using a specific commit SHA (actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683), which locks the workflow to a fixed version. Although this enhances stability, you might consider using the official version tag (for example, actions/checkout@v3) to benefit from future improvements automatically once compatibility is ensured.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between acefdcd and 523ebe5.

📒 Files selected for processing (1)
  • .github/workflows/clp-docs.yaml (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: lint-check (macos-latest)

@kirkrodrigues kirkrodrigues merged commit 2e7f63c into y-scope:main Apr 13, 2025
7 checks passed
@kirkrodrigues kirkrodrigues deleted the docs-lfs branch April 13, 2025 00:42
anlowee pushed a commit to anlowee/clp that referenced this pull request Apr 25, 2025
@kirkrodrigues
fix(ci): Checkout docs with Git-LFS (fixes y-scope#820). (y-scope#821)
af59b34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@davidlion davidlion davidlion approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@kirkrodrigues @davidlion