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

[bazel] Bump to 7.1.0 without bzlmod #13713

Merged
merged 4 commits into from
Mar 21, 2024
Merged

Conversation

shs96c
Copy link
Member

@shs96c shs96c commented Mar 20, 2024

Type

enhancement, configuration changes


Description

  • Bumped Bazel version to 7.1.0 and updated related configurations to disable bzlmod.
  • Refactored Maven publishing in Bazel build scripts for better artifact classification.
  • Added JDK toolchain specification in java_module rule.
  • Updated rules_jvm_external dependency to version 6.0 along with its SHA256.
  • Introduced MODULE.bazel and WORKSPACE.bzlmod files for Selenium with necessary configurations.

Changes walkthrough

Relevant files
Enhancement
export.bzl
Refactor Maven Publishing in Bazel Build                                 

java/private/export.bzl

  • Updated maven_publish function to use artifact and
    classifier_artifacts for better artifact classification.
  • Changed javadocs and source_jar to classifier_artifacts with javadoc
    and sources classifiers.
  • +5/-3     
    module.bzl
    Add JDK Toolchain Specification to Java Module                     

    java/private/module.bzl

  • Added toolchains attribute to java_module rule for specifying JDK
    toolchain.
  • +1/-0     
    Configuration changes
    .bazelrc
    Disable bzlmod in Bazel Configuration                                       

    .bazelrc

    • Added configuration to disable bzlmod.
    +3/-0     
    .bazelversion
    Bump Bazel Version to 7.1.0                                                           

    .bazelversion

    • Updated Bazel version from 6.5.0 to 7.1.0.
    +1/-1     
    MODULE.bazel
    Introduce MODULE.bazel for Selenium                                           

    MODULE.bazel

    • Introduced MODULE.bazel file with module name selenium.
    +1/-0     
    WORKSPACE.bzlmod
    Introduce WORKSPACE.bzlmod for Selenium                                   

    WORKSPACE.bzlmod

    • Added WORKSPACE.bzlmod file with workspace name selenium.
    +2/-0     
    Dependencies
    WORKSPACE
    Update rules_jvm_external Dependency                                         

    WORKSPACE

    • Updated rules_jvm_external version and SHA256.
    +3/-3     

    PR-Agent usage:
    Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    Copy link
    Contributor

    PR Description updated to latest commit (74f27db)

    Copy link
    Contributor

    PR Review

    ⏱️ Estimated effort to review [1-5]

    2, because the changes are mostly configuration updates and straightforward code refactoring. The PR modifies build scripts and configuration files to bump Bazel version, update dependencies, and refine Maven publishing. These changes are not complex but require knowledge of Bazel and the project's build process.

    🧪 Relevant tests

    No

    🔍 Possible issues

    Classifier Artifacts Misconfiguration: The classifier_artifacts dictionary uses the same source jar for both javadoc and sources classifiers. This might be a mistake, as typically, a separate Javadoc jar should be used for the javadoc classifier.

    🔒 Security concerns

    No


    ✨ Review tool usage guide:

    Overview:
    The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
    When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

    /review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...
    

    With a configuration file, use the following template:

    [pr_reviewer]
    some_config1=...
    some_config2=...
    
    Utilizing extra instructions

    The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project.

    Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.

    Examples for extra instructions:

    [pr_reviewer] # /review #
    extra_instructions="""
    In the 'possible issues' section, emphasize the following:
    - Does the code logic cover relevant edge cases?
    - Is the code logic clear and easy to understand?
    - Is the code logic efficient?
    ...
    """
    

    Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

    How to enable\disable automation
    • When you first install PR-Agent app, the default mode for the review tool is:
    pr_commands = ["/review", ...]
    

    meaning the review tool will run automatically on every PR, with the default configuration.
    Edit this field to enable/disable the tool, or to change the used configurations

    Auto-labels

    The review tool can auto-generate two specific types of labels for a PR:

    • a possible security issue label, that detects possible security issues (enable_review_labels_security flag)
    • a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)
    Extra sub-tools

    The review tool provides a collection of possible feedbacks about a PR.
    It is recommended to review the possible options, and choose the ones relevant for your use case.
    Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example:
    require_score_review, require_soc2_ticket, require_can_be_split_review, and more.

    Auto-approve PRs

    By invoking:

    /review auto_approve
    

    The tool will automatically approve the PR, and add a comment with the approval.

    To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following:

    [pr_reviewer]
    enable_auto_approval = true
    

    (this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository)

    You can also enable auto-approval only if the PR meets certain requirements, such as that the estimated_review_effort is equal or below a certain threshold, by adjusting the flag:

    [pr_reviewer]
    maximal_review_effort = 5
    
    More PR-Agent commands

    To invoke the PR-Agent, add a comment using one of the following commands:

    • /review: Request a review of your Pull Request.
    • /describe: Update the PR title and description based on the contents of the PR.
    • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
    • /ask <QUESTION>: Ask a question about the PR.
    • /update_changelog: Update the changelog based on the PR's contents.
    • /add_docs 💎: Generate docstring for new components introduced in the PR.
    • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
    • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

    See the tools guide for more details.
    To list the possible configuration parameters, add a /config comment.

    See the review usage page for a comprehensive guide on using this tool.

    Copy link
    Contributor

    qodo-merge-pro bot commented Mar 20, 2024

    PR Code Suggestions

    CategorySuggestions                                                                                                                                                       
    Maintainability
    Use a variable for repeated string formatting to simplify maintenance.

    Consider using a variable for the repeated "%s-maven-source" % name to ensure consistency
    and simplify future changes.

    java/private/export.bzl [95-96]

    -"javadoc": ":%s-maven-source" % name,
    -"sources": ":%s-maven-source" % name,
    +source_artifact = ":%s-maven-source" % name
    +"javadoc": source_artifact,
    +"sources": source_artifact,
     
    Possible issue
    Verify compatibility when disabling bzlmod.

    Ensure that disabling bzlmod does not impact any dependencies or toolchains that might
    rely on this feature, especially when upgrading Bazel.

    .bazelrc [5]

    +# Ensure compatibility before disabling bzlmod
     common --noenable_bzlmod
     
    Confirm the accuracy of sha256 and strip_prefix for dependencies.

    Verify the sha256 checksum and strip_prefix values for the new version of
    rules_jvm_external to ensure they are correct and match the downloaded artifact.

    WORKSPACE [159-160]

    +# Ensure these values are accurate for the downloaded version
     sha256 = "85fd6bad58ac76cc3a27c8e051e4255ff9ccd8c92ba879670d195622e7c0a9b7",
     strip_prefix = "rules_jvm_external-6.0",
     
    Ensure module declarations are complete and compatible.

    If introducing a module file, ensure that all dependencies and toolchains are correctly
    declared and compatible with the Bazel version and other project dependencies.

    MODULE.bazel [1]

    +# Verify compatibility and completeness of module declarations
     module(name = "selenium")
     
    Best practice
    Test thoroughly after upgrading Bazel.

    After upgrading Bazel, ensure to test the build and run all tests to catch any potential
    issues introduced by the new version.

    .bazelversion [1]

    +# Ensure compatibility with Bazel 7.1.0
     7.1.0
     

    ✨ Improve tool usage guide:

    Overview:
    The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
    When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

    /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...
    

    With a configuration file, use the following template:

    [pr_code_suggestions]
    some_config1=...
    some_config2=...
    
    Enabling\disabling automation

    When you first install the app, the default mode for the improve tool is:

    pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...]
    

    meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.

    Utilizing extra instructions

    Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project.

    Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on.

    Examples for extra instructions:

    [pr_code_suggestions] # /improve #
    extra_instructions="""
    Emphasize the following aspects:
    - Does the code logic cover relevant edge cases?
    - Is the code logic clear and easy to understand?
    - Is the code logic efficient?
    ...
    """
    

    Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

    A note on code suggestions quality
    • While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically.
    • Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base.
    • Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool
    • With large PRs, best quality will be obtained by using 'improve --extended' mode.
    More PR-Agent commands

    To invoke the PR-Agent, add a comment using one of the following commands:

    • /review: Request a review of your Pull Request.
    • /describe: Update the PR title and description based on the contents of the PR.
    • /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback.
    • /ask <QUESTION>: Ask a question about the PR.
    • /update_changelog: Update the changelog based on the PR's contents.
    • /add_docs 💎: Generate docstring for new components introduced in the PR.
    • /generate_labels 💎: Generate labels for the PR based on the PR's contents.
    • /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component.

    See the tools guide for more details.
    To list the possible configuration parameters, add a /config comment.

    See the improve usage page for a more comprehensive guide on using this tool.

    @shs96c shs96c force-pushed the bazel-7-no-bzlmod branch from a2e7f50 to c1e143c Compare March 21, 2024 18:25
    @shs96c shs96c merged commit 12344fe into SeleniumHQ:trunk Mar 21, 2024
    12 of 13 checks passed
    @shs96c shs96c deleted the bazel-7-no-bzlmod branch March 21, 2024 18:33
    shs96c added a commit to shs96c/selenium that referenced this pull request Mar 22, 2024
    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.

    1 participant