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

letsencrypt: Avoid deprecation warnings #3776

Merged
merged 1 commit into from
Sep 27, 2024
Merged

Conversation

agners
Copy link
Member

@agners agners commented Sep 27, 2024

The bump to Cryptography 43.0.1 leads to deprecation warnings (see certbot/certbot#9967). Use the currently recommended (according to their requirements.txt in the tools directory) cryptography version 42.

Summary by CodeRabbit

  • New Features

    • Updated to version 5.2.1, reverting the cryptography library to version 42.0.8 to avoid deprecation warnings.
  • Bug Fixes

    • Resolved deprecation warnings by reverting the cryptography library version.
  • Documentation

    • Changelog updated to reflect the new version and changes.

The bump to Cryptography 43.0.1 leads to deprecation warnings (see
certbot/certbot#9967). Use the currently
recommended (according to their requirements.txt in the tools directory)
cryptography version 42.
@agners agners marked this pull request as ready for review September 27, 2024 07:55
Copy link
Contributor

coderabbitai bot commented Sep 27, 2024

📝 Walkthrough

Walkthrough

The pull request introduces version 5.2.1 for Let's Encrypt, primarily reverting the cryptography library to version 42.0.8 to eliminate deprecation warnings. The previous version, 5.2.0, remains intact, which included updates to Certbot/ACME and various plugins. The configuration files have been updated accordingly to reflect this new version, while no other changes were made to the declarations of exported or public entities.

Changes

File Change Summary
letsencrypt/CHANGELOG.md Updated to version 5.2.1; reverted cryptography library to version 42.0.8.
letsencrypt/build.yaml Updated CRYPTOGRAPHY_VERSION from 43.0.1 to 42.0.8.
letsencrypt/config.yaml Updated version from 5.2.0 to 5.2.1.

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>, 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 resolve resolve all the CodeRabbit review comments.
  • @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 or @coderabbitai title 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.

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

🧹 Outside diff range and nitpick comments (1)
letsencrypt/CHANGELOG.md (1)

3-5: Changelog entry looks good, with a minor suggestion for clarity.

The changelog entry accurately describes the change made in version 5.2.1, which aligns with the PR objectives. The version increment is appropriate for this type of change.

Consider slightly rewording the entry for additional clarity:

- Revert Cryptography to 42.0.8 to avoid deprecation warnings
+ Revert Cryptography library to version 42.0.8 to avoid deprecation warnings

This minor change explicitly mentions that it's the Cryptography library being reverted and specifies "version" for added precision.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 8cc097b and dfc2633.

📒 Files selected for processing (3)
  • letsencrypt/CHANGELOG.md (1 hunks)
  • letsencrypt/build.yaml (1 hunks)
  • letsencrypt/config.yaml (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • letsencrypt/config.yaml
🧰 Additional context used
📓 Path-based instructions (2)
letsencrypt/CHANGELOG.md (6)

Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.

  • Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
  • In step-by-step instructions, front the location phrase in the instructional sentence.
  • In step-by-step instructions, front the 'goal' in the instructional sentence.
  • In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
  • do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'

Pattern */**(html|markdown|md): - Use bold to mark UI strings.

  • If "" are used to mark UI strings, replace them by bold.

Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"


Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.


Pattern */**(html|markdown|md): do not comment on HTML used for icons


Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.

letsencrypt/build.yaml (6)

Pattern */**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.

  • Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
  • In step-by-step instructions, front the location phrase in the instructional sentence.
  • In step-by-step instructions, front the 'goal' in the instructional sentence.
  • In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
  • do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'

Pattern */**(html|markdown|md): - Use bold to mark UI strings.

  • If "" are used to mark UI strings, replace them by bold.

Pattern */**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"


Pattern */**(html|markdown|md): - Use sentence-style capitalization also in headings.


Pattern */**(html|markdown|md): do not comment on HTML used for icons


Pattern */**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.

🔇 Additional comments (1)
letsencrypt/build.yaml (1)

13-13: LGTM! Verify compatibility with other dependencies.

The change from CRYPTOGRAPHY_VERSION 43.0.1 to 42.0.8 aligns with the PR objectives to avoid deprecation warnings. This reversion is consistent with the recommendation in the Certbot project's requirements.txt file.

To ensure this change doesn't introduce compatibility issues, please run the following script to check for any explicit references to the cryptography library version in the codebase:

This will help identify any other files that might need updating or any potential conflicts with the new version.

✅ Verification successful

Let's update the verification script to correctly search for cryptography version references:


Change Verified!

The reversion of CRYPTOGRAPHY_VERSION to 42.0.8 in letsencrypt/build.yaml has been confirmed. Only the Dockerfiles reference the cryptography library using the ${CRYPTOGRAPHY_VERSION} variable, ensuring consistency across the codebase.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for explicit references to cryptography library version

# Search for any mentions of cryptography version
rg --type yaml --type python "cryptography.*4[23]\.0\.[18]" .

# Check requirements files for cryptography version
fd requirements.txt | xargs rg "cryptography"

Length of output: 273


Script:

#!/bin/bash
# Description: Check for explicit references to cryptography library version

# Search for any mentions of cryptography version in YAML and Python files
rg "cryptography.*4[23]\.0\.[18]" --type yaml --type py .

# Check requirements files for cryptography version
fd requirements.txt | xargs rg "cryptography"

Length of output: 238

@frenck frenck merged commit ed0f4e9 into master Sep 27, 2024
10 checks passed
@frenck frenck deleted the letsencrypt-revert-to-42.0.8 branch September 27, 2024 08:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants