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

Add blog post to explain the breaking changes in Java BiDi #1608

Merged
merged 1 commit into from
Mar 28, 2024

Conversation

pujagani
Copy link
Contributor

@pujagani pujagani commented Mar 13, 2024

User description

Related to https://github.com/SeleniumHQ/selenium/pull/13463/files

Thanks for contributing to the Selenium site and documentation!
A PR well described will help maintainers to review and merge it quickly

Before submitting your PR, please check our contributing guidelines.
Avoid large PRs, and help reviewers by making them as simple and short as possible.

Description

Add blog post to explain the breaking changes in Java BiDi due to introduction of circular dependency.

Motivation and Context

Types of changes

  • Change to the site (I have double-checked the Netlify deployment, and my changes look good)
  • Code example added (and I also added the example to all translated languages)
  • Improved translation
  • Added new translation (and I also added a notice to each document missing translation)

Checklist

  • I have read the contributing document.
  • I have used hugo to render the site/docs locally and I am sure it works.

Type

documentation


Description

  • Introduced a new blog post titled "Update imports to use BiDi Java", authored by Puja Jagani, explaining the breaking changes in Java BiDi implementation due to circular dependency issues.
  • The post details the changes users need to make in their import statements for Selenium versions 4.19 and above.
  • It provides a comprehensive explanation of why the change was necessary, including the goal of aligning with W3C BiDi and resolving circular dependency in Bazel.
  • Includes before-and-after code snippets to clearly illustrate the changes in import statements.

Changes walkthrough

Relevant files
Documentation
bidi-java-breaking-change.md
New Blog Post: Explaining Breaking Changes in Java BiDi Implementation

website_and_docs/content/blog/2024/bidi-java-breaking-change.md

  • Introduced a new blog post explaining the breaking change in Java BiDi
    implementation.
  • Detailed the changes required in import statements for Selenium
    versions 4.19 and above.
  • Explained the rationale behind the change and its impact on users.
  • Provided a before-and-after comparison of import statements.
  • +56/-0   

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

    Copy link

    netlify bot commented Mar 13, 2024

    Deploy Preview for selenium-dev ready!

    Name Link
    🔨 Latest commit f66fa33
    🔍 Latest deploy log https://app.netlify.com/sites/selenium-dev/deploys/660576fbcd619d0008ab99b6
    😎 Deploy Preview https://deploy-preview-1608--selenium-dev.netlify.app
    📱 Preview on mobile
    Toggle QR Code...

    QR Code

    Use your smartphone camera to open QR code link.

    To edit notification comments on pull requests, go to your Netlify site configuration.

    @qodo-merge-pro qodo-merge-pro bot added the documentation Improvements or additions to documentation label Mar 13, 2024
    Copy link
    Contributor

    PR Description updated to latest commit (3086495)

    Copy link
    Contributor

    PR Review

    ⏱️ Estimated effort to review [1-5]

    1, because the PR is focused on documentation changes, specifically adding a blog post. The content is straightforward and does not involve code changes that could affect the functionality of the project. Reviewing this PR mainly involves checking for clarity, grammar, and accuracy of the information provided.

    🧪 Relevant tests

    No

    🔍 Possible issues

    No

    🔒 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, 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 13, 2024

    PR Code Suggestions

    No code suggestions found for PR.

    @diemol diemol force-pushed the add-circular-dep-blog branch from 3086495 to f66fa33 Compare March 28, 2024 13:56
    @diemol diemol merged commit 08ebea9 into SeleniumHQ:trunk Mar 28, 2024
    6 checks passed
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    documentation Improvements or additions to documentation Review effort [1-5]: 1
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants