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

Use releases list REST API for data generator #3959

Merged
merged 1 commit into from
Aug 12, 2024
Merged

Use releases list REST API for data generator #3959

merged 1 commit into from
Aug 12, 2024

Conversation

ludeeus
Copy link
Member

@ludeeus ludeeus commented Aug 12, 2024

No description provided.

Copy link
Contributor

coderabbitai bot commented Aug 12, 2024

Walkthrough

Walkthrough

The recent updates enhance the handling of GitHub repository releases, enabling the fetching of multiple releases instead of just the latest one. This change improves error handling, logging, and overall repository data management. Additionally, new fixtures and snapshots have been added to facilitate testing, ensuring better coverage for scenarios involving pre-releases and rate limits.

Changes

Files Change Summary
scripts/data/generate_category_data.py Enhanced concurrent_update_repository function to fetch multiple releases, improved error handling and logging.
tests/common.py Added FIXTURES_PATH constant for better management of test fixture files.
tests/fixtures/proxy/api.github.com/repos/hacs-test-org/integration-basic/releases.json Expanded JSON structure to include detailed information for multiple releases (versions 2.0.0 and 3.0.0).
tests/fixtures/proxy/api.github.com/repos/hacs-test-org/integration-basic/releases/latest.json Introduced a new JSON file for the latest GitHub release containing essential metadata.
tests/scripts/data/test_generate_category_data.py Modified tests to enhance file handling and added a new test case for scenarios with pre-releases.
tests/snapshots/api-usage/tests/scripts/data/test_generate_category_datatest-generate-category-data-error-status-release-304-hacs-test-org-integration-basic.json Changed API endpoint usage from latest to general releases, with updated counts.
tests/snapshots/api-usage/tests/scripts/data/test_generate_category_datatest-generate-category-data-errors-release-cancellederror-hacs-test-org-integration-basic.json Updated JSON structure reflecting the count of releases from 1 to 2; removed the latest endpoint.
tests/snapshots/api-usage/tests/scripts/data/test_generate_category_datatest-generate-category-data-errors-release-error2-hacs-test-org-integration-basic.json Updated count from 1 to 2 and removed the latest releases endpoint.
tests/snapshots/api-usage/tests/scripts/data/test_generate_category_datatest-generate-category-data-errors-release-timeouterror-hacs-test-org-integration-basic.json Modified JSON structure to reflect updated counts for releases.
tests/snapshots/api-usage/tests/scripts/data/test_generate_category_datatest-generate-category-data-with-30plus-prereleases-hacs-test-org-integration-basic.json New JSON file capturing API usage and rate limits for a specific test case.
tests/snapshots/scripts/data/test_generate_category_data_with_30plus_prereleases/integration.json Introduced new structured JSON representation for integration testing.
tests/snapshots/scripts/data/test_generate_category_data_with_prior_content/*.json Added etag_releases field with value "321" to multiple JSON files for enhanced metadata tracking.

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.
    • @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 as 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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

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

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.

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: 3

scripts/data/generate_category_data.py Show resolved Hide resolved
scripts/data/generate_category_data.py Show resolved Hide resolved
scripts/data/generate_category_data.py Show resolved Hide resolved
@ludeeus ludeeus merged commit 16c29a6 into main Aug 12, 2024
25 checks passed
@ludeeus ludeeus deleted the use-list branch August 12, 2024 10:26
@hacs-bot hacs-bot bot added this to the next milestone Aug 12, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Aug 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant