From 6a83aef3755aadd71434f0fa14f62c54a644dd25 Mon Sep 17 00:00:00 2001 From: reuben olinsky Date: Thu, 5 Feb 2026 07:42:43 -0800 Subject: [PATCH 1/3] ci: add workflow to enforce conventional commits --- .github/workflows/check-pr-title.yml | 61 ++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 .github/workflows/check-pr-title.yml diff --git a/.github/workflows/check-pr-title.yml b/.github/workflows/check-pr-title.yml new file mode 100644 index 00000000000..74606158cba --- /dev/null +++ b/.github/workflows/check-pr-title.yml @@ -0,0 +1,61 @@ +# +# NOTE: This workflow was directly based on the sample +# (reference: https://github.com/amannn/action-semantic-pull-request) +# +# Workflows that run on 'pull_request_target' trigger need to be carefully +# reviewed since they run in the context of the PR target and consume unvalidated +# input controlled by a PR submitter. We've reviewed this workflow and +# allow-listed it via the 'zizmor' comment below. +# + +name: "Check PR Title" + +on: + pull_request_target: # zizmor: ignore[dangerous-triggers] + types: + - opened + - edited + - reopened + +# Cancel in-progress runs of this workflow if a new run is triggered. +concurrency: + group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }} + cancel-in-progress: true + +permissions: {} + +jobs: + main: + name: Validate PR title + runs-on: ubuntu-latest + permissions: + pull-requests: write # Needed to post comments on PR + steps: + - uses: amannn/action-semantic-pull-request@v5 + id: lint_pr_title + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - uses: marocchino/sticky-pull-request-comment@v2 + # When the previous steps fails, the workflow would stop. By adding this + # condition you can continue the execution with the populated error message. + if: always() && (steps.lint_pr_title.outputs.error_message != null) + with: + header: pr-title-lint-error + message: | + Hello, and thank you for opening this pull request! 👋🏼 We appreciate the contribution. + + We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and it looks like your proposed title needs to be adjusted. + + Details: + + ``` + ${{ steps.lint_pr_title.outputs.error_message }} + ``` + + # Delete a previous comment when the issue has been resolved + - if: ${{ steps.lint_pr_title.outputs.error_message == null }} + uses: marocchino/sticky-pull-request-comment@v2 + with: + header: pr-title-lint-error + delete: true From a42c82fd72e28c4f3d61a8499ed9ff3b0a696d15 Mon Sep 17 00:00:00 2001 From: reuben olinsky Date: Fri, 13 Feb 2026 09:59:52 -0800 Subject: [PATCH 2/3] fix: address PR feedbak --- .github/workflows/check-pr-title.yml | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/.github/workflows/check-pr-title.yml b/.github/workflows/check-pr-title.yml index 74606158cba..aa104d5eab0 100644 --- a/.github/workflows/check-pr-title.yml +++ b/.github/workflows/check-pr-title.yml @@ -31,12 +31,12 @@ jobs: permissions: pull-requests: write # Needed to post comments on PR steps: - - uses: amannn/action-semantic-pull-request@v5 + - uses: amannn/action-semantic-pull-request@48f256284bd46cdaab1048c3721360e808335d50 # v6.1.1 id: lint_pr_title env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - uses: marocchino/sticky-pull-request-comment@v2 + - uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # v2.9.4 # When the previous steps fails, the workflow would stop. By adding this # condition you can continue the execution with the populated error message. if: always() && (steps.lint_pr_title.outputs.error_message != null) @@ -47,6 +47,8 @@ jobs: We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and it looks like your proposed title needs to be adjusted. + Commits in this repo will typically be prefixed with `fix:`, `feat:`, `docs:`, `chore:`, `refactor:`, `test:`, or `ci:` to indicate the type of change being proposed. The linked specification has more details. + Details: ``` @@ -55,7 +57,7 @@ jobs: # Delete a previous comment when the issue has been resolved - if: ${{ steps.lint_pr_title.outputs.error_message == null }} - uses: marocchino/sticky-pull-request-comment@v2 + uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # v2.9.4 with: header: pr-title-lint-error delete: true From 846ecf272b3ba9b758be6e26d1e88f5d10aa1119 Mon Sep 17 00:00:00 2001 From: reuben olinsky Date: Fri, 13 Feb 2026 19:45:02 -0800 Subject: [PATCH 3/3] fix: apply suggestions from code review Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .github/workflows/check-pr-title.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/check-pr-title.yml b/.github/workflows/check-pr-title.yml index aa104d5eab0..08ba683c72d 100644 --- a/.github/workflows/check-pr-title.yml +++ b/.github/workflows/check-pr-title.yml @@ -37,7 +37,7 @@ jobs: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # v2.9.4 - # When the previous steps fails, the workflow would stop. By adding this + # When the previous step fails, the workflow would stop. By adding this # condition you can continue the execution with the populated error message. if: always() && (steps.lint_pr_title.outputs.error_message != null) with: @@ -56,7 +56,7 @@ jobs: ``` # Delete a previous comment when the issue has been resolved - - if: ${{ steps.lint_pr_title.outputs.error_message == null }} + - if: steps.lint_pr_title.outputs.error_message == null uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # v2.9.4 with: header: pr-title-lint-error