Skip to content

docs: Update instructions for running the code format tool#29596

Merged
phlax merged 3 commits intoenvoyproxy:mainfrom
dynatrace-oss-contrib:update-code-format-docs
Sep 13, 2023
Merged

docs: Update instructions for running the code format tool#29596
phlax merged 3 commits intoenvoyproxy:mainfrom
dynatrace-oss-contrib:update-code-format-docs

Conversation

@joaopgrassi
Copy link
Copy Markdown
Contributor

@joaopgrassi joaopgrassi commented Sep 13, 2023

Commit Message: Update instructions for running the code format tool
Additional Description: #29397 changed the way to run the check_format python script but the some of the docs are still referring to the "old" way of running it, which does not work anymore.
Risk Level:
Testing:
Docs Changes:
Release Notes:
Platform Specific Features:
[Optional Runtime guard:]
[Optional Fixes #Issue]
[Optional Fixes commit #PR or SHA]
[Optional Deprecated:]
[Optional API Considerations:]

Signed-off-by: Joao Grassi <joao.grassi@dynatrace.com>
@repokitteh-read-only
Copy link
Copy Markdown

Docs for this Pull Request will be rendered here:

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

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

🐱

Caused by: #29596 was opened by joaopgrassi.

see: more, trace.

@repokitteh-read-only
Copy link
Copy Markdown

Hi @joaopgrassi, 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: #29596 was opened by joaopgrassi.

see: more, trace.

@phlax
Copy link
Copy Markdown
Member

phlax commented Sep 13, 2023

small formatting issue - you can fish the diff out of artifacts to fix - https://dev.azure.com/cncf/envoy/_build/results?buildId=149074&view=artifacts&pathAsName=false&type=publishedArtifacts

Comment thread support/README.md Outdated
Comment thread support/README.md
```
./tools/code_format/check_format.py fix && ./tools/code_format/format_python_tools.sh fix
```shell
bazel run //tools/code_format:check_format -- fix && ./tools/code_format/format_python_tools.sh fix
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

for ref - it the python formatter mentioned here that we need to excise

Signed-off-by: Joao Grassi <joao.grassi@dynatrace.com>
Copy link
Copy Markdown
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.

couple of optional nits and ci formatting issue but otherwise lgtm

Signed-off-by: Joao Grassi <joao.grassi@dynatrace.com>
Copy link
Copy Markdown
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.

thanks for following up @joaopgrassi - appreciated - lgtm

@phlax phlax enabled auto-merge (squash) September 13, 2023 08:53
@phlax phlax merged commit 3fd14bf into envoyproxy:main Sep 13, 2023
@joaopgrassi joaopgrassi deleted the update-code-format-docs branch October 30, 2023 12:14
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