From 7af97ec51c502ae5170618ea3231f9e79be10fa6 Mon Sep 17 00:00:00 2001 From: ClemensLinnhoff Date: Mon, 12 Feb 2024 17:03:02 +0100 Subject: [PATCH 01/15] Add buf-lint action Signed-off-by: ClemensLinnhoff --- .github/workflows/protobuf.yml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/.github/workflows/protobuf.yml b/.github/workflows/protobuf.yml index da70a5db3..ecc46f218 100644 --- a/.github/workflows/protobuf.yml +++ b/.github/workflows/protobuf.yml @@ -95,6 +95,14 @@ jobs: - name: Build Python run: python setup.py build && python setup.py sdist + - name: lint-protos: + # Install the `buf` CLI + - uses: bufbuild/buf-setup-action@v1 + # Lint your Protobuf sources + - uses: bufbuild/buf-lint-action@v1 + with: + input: . + - name: Install Python run: python -m pip install . From 5fec88513a982ba5d1a90b88be09592362d9a9ea Mon Sep 17 00:00:00 2001 From: ClemensLinnhoff Date: Mon, 12 Feb 2024 17:10:59 +0100 Subject: [PATCH 02/15] Fix workflow file Signed-off-by: ClemensLinnhoff --- .github/workflows/protobuf.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/protobuf.yml b/.github/workflows/protobuf.yml index ecc46f218..00d072452 100644 --- a/.github/workflows/protobuf.yml +++ b/.github/workflows/protobuf.yml @@ -96,12 +96,12 @@ jobs: run: python setup.py build && python setup.py sdist - name: lint-protos: - # Install the `buf` CLI - - uses: bufbuild/buf-setup-action@v1 + # Install the `buf` CLI + uses: bufbuild/buf-setup-action@v1 # Lint your Protobuf sources - - uses: bufbuild/buf-lint-action@v1 + uses: bufbuild/buf-lint-action@v1 with: - input: . + input: . - name: Install Python run: python -m pip install . From af08dd071f51c04921a9fe801de2f58dabed7fc3 Mon Sep 17 00:00:00 2001 From: ClemensLinnhoff Date: Mon, 12 Feb 2024 17:11:50 +0100 Subject: [PATCH 03/15] Fix workflow file Signed-off-by: ClemensLinnhoff --- .github/workflows/protobuf.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/protobuf.yml b/.github/workflows/protobuf.yml index 00d072452..0fa932cab 100644 --- a/.github/workflows/protobuf.yml +++ b/.github/workflows/protobuf.yml @@ -95,7 +95,7 @@ jobs: - name: Build Python run: python setup.py build && python setup.py sdist - - name: lint-protos: + - name: lint-protos # Install the `buf` CLI uses: bufbuild/buf-setup-action@v1 # Lint your Protobuf sources From f678347c66f92b207278a35a5b24492d60e21ecb Mon Sep 17 00:00:00 2001 From: ClemensLinnhoff Date: Mon, 12 Feb 2024 17:14:03 +0100 Subject: [PATCH 04/15] Move linter Signed-off-by: ClemensLinnhoff --- .github/workflows/protobuf.yml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/.github/workflows/protobuf.yml b/.github/workflows/protobuf.yml index 0fa932cab..9732f58ae 100644 --- a/.github/workflows/protobuf.yml +++ b/.github/workflows/protobuf.yml @@ -67,6 +67,14 @@ jobs: working-directory: protobuf-${{ env.PROTOBUF_VERSION }} run: sudo make install && sudo ldconfig + - name: install-buf-cli + uses: bufbuild/buf-setup-action@v1 + + - name: lint-protos + uses: bufbuild/buf-lint-action@v1 + with: + input: . + - name: Install proto2cpp run: git clone --depth 1 https://github.com/OpenSimulationInterface/proto2cpp.git @@ -95,14 +103,6 @@ jobs: - name: Build Python run: python setup.py build && python setup.py sdist - - name: lint-protos - # Install the `buf` CLI - uses: bufbuild/buf-setup-action@v1 - # Lint your Protobuf sources - uses: bufbuild/buf-lint-action@v1 - with: - input: . - - name: Install Python run: python -m pip install . From 0fe23e9b19cbbc9df7578ccbbebf866d5a6d3835 Mon Sep 17 00:00:00 2001 From: ClemensLinnhoff Date: Mon, 12 Feb 2024 17:20:17 +0100 Subject: [PATCH 05/15] Change to reviewdog-action-protolint Signed-off-by: ClemensLinnhoff --- .github/workflows/protobuf.yml | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/.github/workflows/protobuf.yml b/.github/workflows/protobuf.yml index 9732f58ae..eddaf5573 100644 --- a/.github/workflows/protobuf.yml +++ b/.github/workflows/protobuf.yml @@ -67,13 +67,15 @@ jobs: working-directory: protobuf-${{ env.PROTOBUF_VERSION }} run: sudo make install && sudo ldconfig - - name: install-buf-cli - uses: bufbuild/buf-setup-action@v1 - - name: lint-protos - uses: bufbuild/buf-lint-action@v1 + uses: yoheimuta/action-protolint@v1 with: - input: . + github_token: ${{ secrets.github_token }} + # Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review]. + reporter: github-pr-review + # Change reporter level if you need. + # GitHub Status Check won't become failure with warning. + level: warning - name: Install proto2cpp run: git clone --depth 1 https://github.com/OpenSimulationInterface/proto2cpp.git From 5a49c62a1ac139a83390a58a44d906dc2f61c78d Mon Sep 17 00:00:00 2001 From: ClemensLinnhoff Date: Mon, 12 Feb 2024 17:20:45 +0100 Subject: [PATCH 06/15] Test without github_token Signed-off-by: ClemensLinnhoff --- .github/workflows/protobuf.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/protobuf.yml b/.github/workflows/protobuf.yml index eddaf5573..3491f63e7 100644 --- a/.github/workflows/protobuf.yml +++ b/.github/workflows/protobuf.yml @@ -70,7 +70,6 @@ jobs: - name: lint-protos uses: yoheimuta/action-protolint@v1 with: - github_token: ${{ secrets.github_token }} # Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review]. reporter: github-pr-review # Change reporter level if you need. From f06e8adfdad04e56ed961dc51d3472bb533d8c64 Mon Sep 17 00:00:00 2001 From: ClemensLinnhoff Date: Mon, 12 Feb 2024 17:26:31 +0100 Subject: [PATCH 07/15] Change reporter type Signed-off-by: ClemensLinnhoff --- .github/workflows/protobuf.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/protobuf.yml b/.github/workflows/protobuf.yml index 3491f63e7..4ae50b4f0 100644 --- a/.github/workflows/protobuf.yml +++ b/.github/workflows/protobuf.yml @@ -71,7 +71,7 @@ jobs: uses: yoheimuta/action-protolint@v1 with: # Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review]. - reporter: github-pr-review + reporter: github-check # Change reporter level if you need. # GitHub Status Check won't become failure with warning. level: warning From d202af5e415410f299f27f3164512adeb6fceb05 Mon Sep 17 00:00:00 2001 From: ClemensLinnhoff Date: Mon, 12 Feb 2024 17:33:47 +0100 Subject: [PATCH 08/15] Add test cases Signed-off-by: ClemensLinnhoff --- osi_object.proto | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/osi_object.proto b/osi_object.proto index 9d802b680..f6090d462 100644 --- a/osi_object.proto +++ b/osi_object.proto @@ -216,6 +216,20 @@ message StationaryObject // in the environment, like street lights. // TYPE_EMITTING_STRUCTURE = 18; + + // Test enum case + // + TYPE_test = 19; + + // Test missing prefix + // + TEST = 20; + + // Test same number + // + TYPE_SAME_NUMBER = 20; + + TYPE_MISSING_COMMENT= 22; } // Definition of material types. From a018ef0885503ff948974bdb41e1bcf5de3e7b59 Mon Sep 17 00:00:00 2001 From: ClemensLinnhoff Date: Mon, 12 Feb 2024 17:54:37 +0100 Subject: [PATCH 09/15] Add GitHub token Signed-off-by: ClemensLinnhoff --- .github/workflows/protobuf.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/protobuf.yml b/.github/workflows/protobuf.yml index 4ae50b4f0..b626747b6 100644 --- a/.github/workflows/protobuf.yml +++ b/.github/workflows/protobuf.yml @@ -70,6 +70,7 @@ jobs: - name: lint-protos uses: yoheimuta/action-protolint@v1 with: + github_token: ${{ secrets.github_token }} # Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review]. reporter: github-check # Change reporter level if you need. From 01fbf1d63bf49ba448c50e7aff1a52ae5e1409ea Mon Sep 17 00:00:00 2001 From: ClemensLinnhoff Date: Mon, 12 Feb 2024 18:13:10 +0100 Subject: [PATCH 10/15] Try different settings for Linter Signed-off-by: ClemensLinnhoff --- .github/workflows/protobuf.yml | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/.github/workflows/protobuf.yml b/.github/workflows/protobuf.yml index b626747b6..36f242ec0 100644 --- a/.github/workflows/protobuf.yml +++ b/.github/workflows/protobuf.yml @@ -67,15 +67,13 @@ jobs: working-directory: protobuf-${{ env.PROTOBUF_VERSION }} run: sudo make install && sudo ldconfig - - name: lint-protos + - name: Lint Proto Files uses: yoheimuta/action-protolint@v1 with: github_token: ${{ secrets.github_token }} # Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review]. - reporter: github-check - # Change reporter level if you need. - # GitHub Status Check won't become failure with warning. - level: warning + reporter: github-pr-review + filter_mode: nofilter - name: Install proto2cpp run: git clone --depth 1 https://github.com/OpenSimulationInterface/proto2cpp.git From 617b54d4a7790885910524a6cb8ac4b1545e24ff Mon Sep 17 00:00:00 2001 From: ClemensLinnhoff Date: Mon, 12 Feb 2024 19:50:13 +0100 Subject: [PATCH 11/15] Put linter to separate job and add protolint config Signed-off-by: ClemensLinnhoff --- .github/workflows/protobuf.yml | 12 +++++++++ .protolint.yaml | 46 ++++++++++++++++++++++++++++++++++ 2 files changed, 58 insertions(+) create mode 100644 .protolint.yaml diff --git a/.github/workflows/protobuf.yml b/.github/workflows/protobuf.yml index 36f242ec0..4502b10b9 100644 --- a/.github/workflows/protobuf.yml +++ b/.github/workflows/protobuf.yml @@ -11,6 +11,18 @@ on: branches: [ master ] jobs: + lint-protobuf: + name: Protobuf Linter + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: yoheimuta/action-protolint@v1 + with: + github_token: ${{ secrets.github_token }} + # Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review]. + reporter: github-pr-check + filter_mode: nofilter + build-proto2-linux64: name: Build Proto2 Linux 64 diff --git a/.protolint.yaml b/.protolint.yaml new file mode 100644 index 000000000..4d10d9595 --- /dev/null +++ b/.protolint.yaml @@ -0,0 +1,46 @@ +--- +# Lint directives. +lint: + # Linter rules. + # Run `protolint list` to see all available rules. + rules: + # Determines whether or not to include the default set of linters. + all_default: true + + remove: + - REPEATED_FIELD_NAMES_PLURALIZED + - FIELD_NAMES_EXCLUDE_PREPOSITIONS + - FILE_HAS_COMMENT + - ORDER + - IMPORTS_SORTED + + # Linter rules option. + rules_option: + # MAX_LINE_LENGTH rule option. + max_line_length: + # Enforces a maximum line length + max_chars: 400 + # Specifies the character count for tab characters + tab_chars: 4 + + # INDENT rule option. + indent: + # Available styles are 4(4-spaces), 2(2-spaces) or tab. + style: 4 + # Specifies if it should stop considering and inserting new lines at the appropriate positions + # when the inner elements are on the same line. Default is false. + not_insert_newline: false + + # QUOTE_CONSISTENT rule option. + quote_consistent: + # Available quote are "double" or "single". + quote: double + + # ENUM_FIELD_NAMES_ZERO_VALUE_END_WITH rule option. + enum_field_names_zero_value_end_with: + suffix: UNKNOWN + + # SYNTAX_CONSISTENT rule option. + syntax_consistent: + # Default is proto3. + version: proto2 \ No newline at end of file From 01bcdbf3ddd3417bf84e4b65fc328439d8dc36c2 Mon Sep 17 00:00:00 2001 From: ClemensLinnhoff Date: Mon, 12 Feb 2024 19:53:14 +0100 Subject: [PATCH 12/15] Remove same number test case Signed-off-by: ClemensLinnhoff --- .github/workflows/protobuf.yml | 2 +- osi_object.proto | 6 +----- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/.github/workflows/protobuf.yml b/.github/workflows/protobuf.yml index 4502b10b9..e16c44c1b 100644 --- a/.github/workflows/protobuf.yml +++ b/.github/workflows/protobuf.yml @@ -13,7 +13,7 @@ on: jobs: lint-protobuf: name: Protobuf Linter - runs-on: ubuntu-latest + runs-on: ubuntu-22.04 steps: - uses: actions/checkout@v4 - uses: yoheimuta/action-protolint@v1 diff --git a/osi_object.proto b/osi_object.proto index f6090d462..56dd22c97 100644 --- a/osi_object.proto +++ b/osi_object.proto @@ -225,11 +225,7 @@ message StationaryObject // TEST = 20; - // Test same number - // - TYPE_SAME_NUMBER = 20; - - TYPE_MISSING_COMMENT= 22; + TYPE_MISSING_COMMENT= 21; } // Definition of material types. From 7f6548509f6313fc03dd282832da769ecc635ac1 Mon Sep 17 00:00:00 2001 From: ClemensLinnhoff Date: Mon, 12 Feb 2024 20:01:37 +0100 Subject: [PATCH 13/15] Disable enum suffix rule Signed-off-by: ClemensLinnhoff --- .protolint.yaml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.protolint.yaml b/.protolint.yaml index 4d10d9595..da9e5cdfe 100644 --- a/.protolint.yaml +++ b/.protolint.yaml @@ -13,6 +13,7 @@ lint: - FILE_HAS_COMMENT - ORDER - IMPORTS_SORTED + - ENUM_FIELD_NAMES_ZERO_VALUE_END_WITH # Linter rules option. rules_option: @@ -37,8 +38,8 @@ lint: quote: double # ENUM_FIELD_NAMES_ZERO_VALUE_END_WITH rule option. - enum_field_names_zero_value_end_with: - suffix: UNKNOWN + #enum_field_names_zero_value_end_with: + # suffix: UNKNOWN # SYNTAX_CONSISTENT rule option. syntax_consistent: From d52a8c7f517768dd8c1dab510052ab55dab42701 Mon Sep 17 00:00:00 2001 From: ClemensLinnhoff Date: Mon, 12 Feb 2024 20:03:40 +0100 Subject: [PATCH 14/15] Disable message names prepositions Signed-off-by: ClemensLinnhoff --- .protolint.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.protolint.yaml b/.protolint.yaml index da9e5cdfe..fe1302088 100644 --- a/.protolint.yaml +++ b/.protolint.yaml @@ -10,6 +10,7 @@ lint: remove: - REPEATED_FIELD_NAMES_PLURALIZED - FIELD_NAMES_EXCLUDE_PREPOSITIONS + - MESSAGE_NAMES_EXCLUDE_PREPOSITIONS - FILE_HAS_COMMENT - ORDER - IMPORTS_SORTED From 21013d935302955d2849685a2f4a1760d615e350 Mon Sep 17 00:00:00 2001 From: ClemensLinnhoff Date: Mon, 12 Feb 2024 20:06:27 +0100 Subject: [PATCH 15/15] Remove linter from build job Signed-off-by: ClemensLinnhoff --- .github/workflows/protobuf.yml | 8 -------- 1 file changed, 8 deletions(-) diff --git a/.github/workflows/protobuf.yml b/.github/workflows/protobuf.yml index e16c44c1b..c7d58ee4f 100644 --- a/.github/workflows/protobuf.yml +++ b/.github/workflows/protobuf.yml @@ -79,14 +79,6 @@ jobs: working-directory: protobuf-${{ env.PROTOBUF_VERSION }} run: sudo make install && sudo ldconfig - - name: Lint Proto Files - uses: yoheimuta/action-protolint@v1 - with: - github_token: ${{ secrets.github_token }} - # Change reviewdog reporter if you need [github-pr-check,github-check,github-pr-review]. - reporter: github-pr-review - filter_mode: nofilter - - name: Install proto2cpp run: git clone --depth 1 https://github.com/OpenSimulationInterface/proto2cpp.git