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.

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

Always use ref for validation #3429

Merged
merged 3 commits into from May 23, 2024
Merged

Always use ref for validation #3429

merged 3 commits into from May 23, 2024

Conversation

ludeeus
Copy link
Member

@ludeeus ludeeus commented Jan 2, 2024

Closes #3428
Needs some better testing.

@elchininet
Copy link

Hi @ludeeus,

Not sure if this refactor will fix this, but I noticed that during a pull request the action fails, but later on, when the PR is merged it works OK in master. Let me know if this will be fixed with this PR.

Regards

@ludeeus
Copy link
Member Author

ludeeus commented Feb 5, 2024

That is what this PR changes.

@elchininet
Copy link

Perfect then,
I wanted to be sure :)
Thanks

@ludeeus ludeeus marked this pull request as ready for review May 23, 2024 12:29
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented May 23, 2024 •
edited

Warning

Rate Limit Exceeded

@ludeeus has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 34 minutes and 20 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 3923a98 and b2d44dc.

Walkthrough

The changes introduce a new version parameter to the async_get_info_file_contents and get_documentation functions within the Base class in base.py. This parameter allows these functions to fetch information based on a specified version. Additionally, in images.py, the validate method of the Validator class now passes the current repository reference (self.repository.ref) as the version parameter to the async_get_info_file_contents method. These changes ensure that validation can be performed on the current branch rather than only the latest release.

Changes

File Path Change Summary
custom_components/hacs/repositories/base.py Added version parameter to async_get_info_file_contents and get_documentation functions.
custom_components/hacs/validate/images.py Modified validate method to pass version=self.repository.ref to async_get_info_file_contents.

Assessment against linked issues

Objective Addressed Explanation
Ensure validation works with the current branch, not just the latest release (#3428). ✅
Modify async_get_info_file_contents to accept a version parameter (#3428). ✅
Adjust get_documentation to handle the version parameter appropriately (#3428). ✅
Update validate method to use the current branch reference for validation (#3428). ✅

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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 requested changes May 23, 2024
View reviewed changes
Copy link

@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: 1

custom_components/hacs/repositories/base.py Show resolved Hide resolved
@ludeeus ludeeus enabled auto-merge (squash) May 23, 2024 12:52
@ludeeus ludeeus merged commit 44e253e into main May 23, 2024
28 checks passed
@ludeeus ludeeus deleted the always-use-ref-for-validation branch May 23, 2024 12:52
@hacs-bot hacs-bot bot added this to the next milestone May 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai approved these changes

Assignees
No one assigned
Labels
pr: bugfix
Projects
None yet
Milestone
next
Development

Successfully merging this pull request may close these issues.

Validation will only use the latest release version - not the branch I work in?
2 participants
@ludeeus @elchininet