ci: add workflow to enforce conventional commits #15734
Conversation
ddstreetmicrosoft
left a comment
ddstreetmicrosoft
left a comment
There was a problem hiding this comment.
some comments only, I'll leave this to Chris for approval
| name: "Check PR Title" | ||
|
|
||
| on: | ||
| pull_request_target: # zizmor: ignore[dangerous-triggers] |
There was a problem hiding this comment.
do we need to restrict this to only PRs against tomls/base/main? We don't want this running for all PRs against the entire azl repo, right?
| permissions: | ||
| pull-requests: write # Needed to post comments on PR | ||
| steps: | ||
| - uses: amannn/action-semantic-pull-request@v5 |
There was a problem hiding this comment.
is this creating a dependency on an external repo? if so, we should probably clone and use our own repo/branch right?
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
|
|
||
| - uses: marocchino/sticky-pull-request-comment@v2 |
There was a problem hiding this comment.
same question as above about external repo use?
|
|
||
| # 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 |
There was a problem hiding this comment.
same question as above about external repo use?
| if: always() && (steps.lint_pr_title.outputs.error_message != null) | ||
| with: | ||
| header: pr-title-lint-error | ||
| message: | |
There was a problem hiding this comment.
Can we also include a TL;DR on common formatting? Probably 99% of commits will want to use just a few common formats, e.g. feat:, fix:, etc.
On the conventialcommits.org page, even the Quick Summary isn't a good reference (IMHO) on the most common uses, it takes a bit of reading to see what options there are
2 participants
We're planning to adopt Conventional Commits in this branch; this workflow helps guide contributors to following the guidelines.