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] Rename remote config to rbe #15496

Merged
merged 1 commit into from
Mar 24, 2025

Conversation

shs96c
Copy link
Member

@shs96c shs96c commented Mar 24, 2025

User description

In the Selenium project, remote may refer to a number of different things:

  • A driver running on the local machine, but not in process
  • A driver running remotely, in Grid or a Selenium As A Service provider
  • The remote protocol we're using
  • The remote Bazel config for builds

To reduce this plethora of options, renaming the Bazel remote config to rbe will help.


PR Type

Enhancement, Documentation


Description

  • Renamed Bazel remote configuration to rbe for clarity.

  • Updated all references to remote in scripts and configuration files.

  • Adjusted documentation to reflect the configuration name change.

  • Ensured consistency across build and test configurations.


Changes walkthrough 📝

Relevant files
Enhancement
ci-build.sh
Update CI build script to use `rbe` configuration               

scripts/github-actions/ci-build.sh

  • Replaced --config=remote-ci with --config=rbe-ci.
  • Updated build and test commands to use the new configuration name.
  • +2/-2     
    .bazelrc
    Rename `remote` to `rbe` in Bazel configuration                   

    .bazelrc

  • Renamed remote_release to rbe_release.
  • Updated references from remote to rbe in build configurations.
  • +3/-3     
    .bazelrc.remote
    Update `.bazelrc.remote` to use `rbe` configuration           

    .bazelrc.remote

  • Replaced all remote configurations with rbe.
  • Updated test and build environment settings for rbe.
  • +41/-41 
    Rakefile
    Update Rakefile tasks to use `rbe` configuration                 

    Rakefile

  • Replaced --config=remote_release with --config=rbe_release.
  • Adjusted task descriptions to align with the new configuration name.
  • +1/-1     
    Documentation
    CONTRIBUTING.md
    Update documentation to reflect `rbe` configuration           

    CONTRIBUTING.md

  • Updated documentation to reference --config=rbe instead of
    --config=remote.
  • Clarified usage of the new configuration in examples.
  • +2/-2     

    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
  • In the Selenium project, `remote` may refer to a number of different
    things:
    
     * A driver running on the local machine, but not in process
     * A driver running remotely, in Grid or a Selenium As A Service provider
     * The remote protocol we're using
     * The `remote` Bazel config for builds
    
    To reduce this plethora of options, renaming the Bazel `remote`
    config to `rbe` will help.
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Test Tag Filter

    The test tag filter still includes -remote which might need to be updated to -rbe for consistency with the renaming pattern.

    test:rbe --test_tag_filters=-exclusive-if-local,-skip-rbe,-remote

    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    General
    Update test tag filters

    The test tag filter still contains '-remote' which should be updated to align
    with the new naming convention. Consider removing the '-remote' tag or replacing
    it with a new tag that follows the 'rbe' naming pattern.

    .bazelrc.remote [34]

    -test:rbe --test_tag_filters=-exclusive-if-local,-skip-rbe,-remote
    +test:rbe --test_tag_filters=-exclusive-if-local,-skip-rbe
    • Apply this suggestion
    Suggestion importance[1-10]: 8

    __

    Why: This is an important catch that would cause issues. The test tag filter still excludes tests with the '-remote' tag, but since the configuration is now 'rbe', this filter should be updated to maintain proper test filtering behavior.

    Medium
    Maintain consistent naming convention

    Update the EXECUTOR definition to match the new naming convention. Since you're
    renaming all 'remote' references to 'rbe', consider changing the EXECUTOR value
    from 'remote' to 'rbe' for consistency.

    .bazelrc.remote [10]

    -build:rbe --define=EXECUTOR=remote
    +build:rbe --define=EXECUTOR=rbe
    • Apply this suggestion
    Suggestion importance[1-10]: 7

    __

    Why: The suggestion correctly identifies an inconsistency in the naming convention. Since all other 'remote' references are being changed to 'rbe', updating the EXECUTOR value maintains consistency throughout the configuration files.

    Medium
    • More

    @shs96c shs96c merged commit 46eb0b5 into SeleniumHQ:trunk Mar 24, 2025
    23 checks passed
    @shs96c shs96c deleted the rename-remote-to-rbe branch March 24, 2025 10:07
    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