Skip to content

Commit bfd9f31

Browse files
authored
ci: add pr naming workflow (#2698)
1 parent 59af7e2 commit bfd9f31

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

.github/workflows/pr_naming.yml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
name: PR Conventional Commit Validation
2+
3+
on:
4+
pull_request:
5+
types: [opened, synchronize, reopened, edited]
6+
7+
jobs:
8+
validate-pr-title:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: PR Conventional Commit Validation
12+
uses: ytanikin/[email protected]
13+
with:
14+
task_types: '["build","chore","ci","docs","feat","fix","perf","refactor","revert","test"]'
15+
add_label: 'false'

CONTRIBUTING.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,11 @@ Open a pull request against the main
7878
[opentelemetry-rust](https://github.com/open-telemetry/opentelemetry-rust)
7979
repo.
8080

81+
Your pull request should be named according to the
82+
[conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) standard. This ensures that
83+
when the PR is squashed into `main`, the resulting commit message is consistent and makes it easier
84+
for us to generate a changelog standard.
85+
8186
> **Note**
8287
> It is recommended to run [pre-commit script](scripts/precommit.sh) to catch any issues locally.
8388

0 commit comments

Comments
 (0)