cilium / cilium/proxy

dev: Add proto tools/proto_format/proto_format.sh in make {fix,check}

Open
#140 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
190
Forks
99
Avg merge
1d 5h
Merged PRs (30d)
30

Description

Description

After envoy 1.24.x upgrade, make fix is no longer running proto format.

vagrant@ubuntu-jammy:~/proxy$ make fix
BUILDING on amd64 for amd64 using //bazel:linux_x86_64
Using Docker Buildx builder "default" with build flags "".
tools/install_bazel.sh `cat .bazelversion`
Checking if Bazel 6.0.0 needs to be installed...
Bazel 6.0.0 already installed, skipping fetch.
bazel  build --platforms=//bazel:linux_x86_64 --config=release //:check_format.py
INFO: Build options --compilation_mode, --crosstool_top, --define, and 3 more have changed, discarding analysis cache.
INFO: Analyzed target //:check_format.py (118 packages loaded, 359 targets configured).
INFO: Found 1 target...
Target //:check_format.py up-to-date:
  bazel-bin/check_format.py
INFO: Elapsed time: 0.944s, Critical Path: 0.02s
INFO: 6 processes: 6 internal.
INFO: Build completed successfully, 6 total actions
CLANG_FORMAT=clang-format-15 BUILDIFIER=~/go/bin/buildifier BUILDOZER=~/go/bin/buildozer ./bazel-bin/check_format.py --skip_envoy_build_rule_check --add-excluded-prefixes "./linux/" "./proxylib/" --bazel_tools_check_excluded_paths="." --build_fixer_check_excluded_paths="./" fix
Please note: `tools/code_format/check_format.py` no longer checks API `.proto` files, please use `tools/proto_format/proto_format.sh` if you are making changes to the API files

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the make fix and make check targets and reading tools/code_format/check_format.py, then determine how tools/proto_format/proto_format.sh should be invoked for API .proto files. Done means both targets run the proto formatter or checker as appropriate, without losing the existing formatting checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
shell
Domain
build-system
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.