From ed19c75483f3dfc375c502102845a4b0cbbe3632 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Fri, 21 Feb 2025 11:11:29 +0100 Subject: [PATCH 1/4] chore: add pr naming workflow --- .github/workflows/pr_naming.yaml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 .github/workflows/pr_naming.yaml diff --git a/.github/workflows/pr_naming.yaml b/.github/workflows/pr_naming.yaml new file mode 100644 index 0000000000..57a649c960 --- /dev/null +++ b/.github/workflows/pr_naming.yaml @@ -0,0 +1,15 @@ +name: PR Conventional Commit Validation + +on: + pull_request: + types: [opened, synchronize, reopened, edited] + +jobs: + validate-pr-title: + runs-on: ubuntu-latest + steps: + - name: PR Conventional Commit Validation + uses: ytanikin/pr-conventional-commits@1.4.0 + with: + task_types: '["feat","fix","docs","test","ci","refactor","perf","chore","revert"]' + add_label: 'false' From bf22abe3f86862257a8652ecb10a55eeb21b7142 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Fri, 21 Feb 2025 11:23:55 +0100 Subject: [PATCH 2/4] Add note about conventional commits --- CONTRIBUTING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 746e34806a..0bea7c7df5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -78,6 +78,13 @@ Open a pull request against the main [opentelemetry-rust](https://github.com/open-telemetry/opentelemetry-rust) repo. +Your pull request should be named according to the +[conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) standard. This ensures that +when the PR is squashed into `main`, the resulting commit message is consistent and makes it easier +for us to generate a changelog standard. This ensures that +when the PR is squashed into `main`, the resulting commit message is consistent and makes it easier +for us to generate a changelog. + > **Note** > It is recommended to run [pre-commit script](scripts/precommit.sh) to catch any issues locally. From 6e3d81fbcceb33ccb142561cc995bc4466d2b546 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Tue, 25 Feb 2025 09:31:08 +0100 Subject: [PATCH 3/4] address review feedback --- .github/workflows/pr_naming.yaml | 2 +- CONTRIBUTING.md | 4 +--- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/.github/workflows/pr_naming.yaml b/.github/workflows/pr_naming.yaml index 57a649c960..809955198d 100644 --- a/.github/workflows/pr_naming.yaml +++ b/.github/workflows/pr_naming.yaml @@ -11,5 +11,5 @@ jobs: - name: PR Conventional Commit Validation uses: ytanikin/pr-conventional-commits@1.4.0 with: - task_types: '["feat","fix","docs","test","ci","refactor","perf","chore","revert"]' + task_types: '["build","chore","ci","docs","feat","fix","perf","refactor","revert","test"]' add_label: 'false' diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0bea7c7df5..c3317b983d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -81,9 +81,7 @@ repo. Your pull request should be named according to the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) standard. This ensures that when the PR is squashed into `main`, the resulting commit message is consistent and makes it easier -for us to generate a changelog standard. This ensures that -when the PR is squashed into `main`, the resulting commit message is consistent and makes it easier -for us to generate a changelog. +for us to generate a changelog standard. > **Note** > It is recommended to run [pre-commit script](scripts/precommit.sh) to catch any issues locally. From 45a5b9bd14c82228ccbf3b803f1b01f3a0292e16 Mon Sep 17 00:00:00 2001 From: Scott Gerring Date: Tue, 25 Feb 2025 09:33:35 +0100 Subject: [PATCH 4/4] consistency --- .github/workflows/{pr_naming.yaml => pr_naming.yml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename .github/workflows/{pr_naming.yaml => pr_naming.yml} (100%) diff --git a/.github/workflows/pr_naming.yaml b/.github/workflows/pr_naming.yml similarity index 100% rename from .github/workflows/pr_naming.yaml rename to .github/workflows/pr_naming.yml