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

Deprecate helpers.sigstore_verify_release_asset #304

Merged
merged 6 commits into from
May 21, 2024

Conversation

ludeeus
Copy link
Owner

@ludeeus ludeeus commented May 21, 2024

Proposed change

The sigstore_verify_release_asset function in the helper module is now deprecated.
Its dependencies is no longer requested by default, you need to add the add the deprecated-verify extra when installing to get those.

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (which adds functionalit)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue:

Checklist

  • The code change is tested and works locally.
  • Local tests pass.
  • There is no commented out code in this PR.
  • The code has been formatted using Black (make lint)
  • Tests have been added to verify that the new code works.

Copy link

coderabbitai bot commented May 21, 2024

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 8 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 d4d699e and 133d5d1.

Walkthrough

The recent updates focus on improving dependency management by adding optional dependencies and deprecating certain verification functionalities. The Makefile now includes the --extras "deprecated-verify" flag in poetry install commands. Refactoring in aiogithubapi/helpers.py deprecates the sigstore_verify_release_asset function. Changes in pyproject.toml and test files ensure proper handling of dependencies and verification logic.

Changes

File Change Summary
Makefile Added --extras "deprecated-verify" flag to poetry install commands in requirements and install targets.
README.md Updated to reflect changes in aiogithubapi module, including function and class replacements.
aiogithubapi/helpers.py Refactored imports for type hints, deprecated sigstore_verify_release_asset function with a warning.
pyproject.toml Added optional dependencies for sigstore and securesystemslib, and defined deprecated-verify extras.
tests/test_helper.py Updated import paths for Verifier.verify and VerificationMaterials.from_bundle in test functions.

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:

Note: Auto-reply has been disabled for this repository by the repository owner. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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.

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

Outside diff range and nitpick comments (1)
tests/test_helper.py (1)

Line range hint 2-2: Remove the unused import io.BytesIO to clean up the code.

- from io import BytesIO

README.md Show resolved Hide resolved
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

Outside diff range and nitpick comments (1)
aiogithubapi/helpers.py (1)

Line range hint 11-12: Remove unused imports to clean up the code.

- from .legacy.helpers import (
-     async_call_api as legacy_async_call_api,
-     short_message,
-     short_sha,
- )
+ from .legacy.helpers import (
+     async_call_api as legacy_async_call_api,
+ )

The imports short_message and short_sha are unused and should be removed to maintain clean and maintainable code.

aiogithubapi/helpers.py Outdated Show resolved Hide resolved
@ludeeus ludeeus merged commit 2a5c714 into main May 21, 2024
7 checks passed
@ludeeus ludeeus deleted the deprecate.sigstore_verify_release_asset branch May 21, 2024 14:09
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.

1 participant