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

docs: new parameter name for the bazel remote cache #22170

Merged
merged 1 commit into from
Jul 14, 2022

Conversation

mkauf
Copy link
Contributor

@mkauf mkauf commented Jul 13, 2022

docs: new parameter name for the bazel remote cache

The bazel parameter '--remote_http_cache' has been renamed to
'--remote_cache'. Use the new name.

Signed-off-by: Michael Kaufmann michael.kaufmann@ergon.ch

Risk Level: Low

@repokitteh-read-only
Copy link

Docs for this Pull Request will be rendered here:

https://storage.googleapis.com/envoy-pr/22170/docs/index.html

The docs are (re-)rendered each time the CI envoy-presubmit (precheck docs) job completes.

🐱

Caused by: #22170 was opened by mkauf.

see: more, trace.

@repokitteh-read-only
Copy link

Hi @mkauf, welcome and thank you for your contribution.

We will try to review your Pull Request as quickly as possible.

In the meantime, please take a look at the contribution guidelines if you have not done so already.

🐱

Caused by: #22170 was opened by mkauf.

see: more, trace.

Copy link
Member

@phlax phlax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mkauf the flag change in bazel/README looks correct

regarding BAZEL_REMOTE_CACHE - is this automatically detected by bazel ?

im also wondering why not use the existing env var for this

cc @lizan

@mkauf
Copy link
Contributor Author

mkauf commented Jul 13, 2022

@phlax

regarding BAZEL_REMOTE_CACHE - is this automatically detected by bazel ?

No, this environment variable is handled in setup_cache.sh (https://github.com/envoyproxy/envoy/blob/v1.22.2/ci/setup_cache.sh#L23)

@phlax
Copy link
Member

phlax commented Jul 13, 2022

i see, but then im wondering why change it - iiuc it is just going to set the BAZEL_BUILD_EXTRA_OPTIONS and skip the undocumented envoy ci setup

with the original way it gives the end user more flexibility because they can also pass other args that way - no ?

@mkauf
Copy link
Contributor Author

mkauf commented Jul 13, 2022

I think the purpose of the environment variable BAZEL_REMOTE_CACHE is to pass the URL to the bazel remote cache. Of course, if you need more flexibility, then use BAZEL_BUILD_EXTRA_OPTIONS. (after all, it's just a change in the readme, not in the code)

But if you think that using BAZEL_REMOTE_CACHE is a bad idea, I can adjust the commit.

@phlax
Copy link
Member

phlax commented Jul 13, 2022

cool, lets keep the docs for BAZEL_BUILD_EXTRA_OPTIONS and adjust the docs for the RBE flags

bazel/README.md Show resolved Hide resolved
Copy link
Member

@phlax phlax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mkauf if you can rever the change to the extra_options env var then this should be good to land

@phlax phlax self-assigned this Jul 13, 2022
@phlax
Copy link
Member

phlax commented Jul 14, 2022

/wait

The bazel parameter '--remote_http_cache' has been renamed to
'--remote_cache'. Use the new name.

Signed-off-by: Michael Kaufmann <michael.kaufmann@ergon.ch>
@mkauf mkauf force-pushed the docs-bazel-remote-cache branch from ea3c094 to 30adf51 Compare July 14, 2022 12:36
@mkauf mkauf changed the title docs: new parameter and env variable for the bazel remote cache docs: new parameter name for the bazel remote cache Jul 14, 2022
@mkauf
Copy link
Contributor Author

mkauf commented Jul 14, 2022

I have updated the pull request.

Copy link
Member

@phlax phlax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great, thanks @mkauf , lgtm

@phlax phlax enabled auto-merge (squash) July 14, 2022 12:40
@phlax phlax merged commit d9030e3 into envoyproxy:main Jul 14, 2022
@mkauf mkauf deleted the docs-bazel-remote-cache branch July 15, 2022 08:57
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.

2 participants