diff --git a/.github/workflows/lint-commit-messages.yaml b/.github/workflows/lint-commit-messages.yaml new file mode 100644 index 0000000000..3e812f2ead --- /dev/null +++ b/.github/workflows/lint-commit-messages.yaml @@ -0,0 +1,19 @@ +name: "Lint Commit Messages" +on: + pull_request: + +permissions: + contents: read + pull-requests: read + +concurrency: + group: ${{ github.workflow }}-${{ github.event.pull_request.number }} # Ensure that only one instance of this workflow is running per Pull Request + cancel-in-progress: true # Cancel any previous runs of this workflow + +jobs: + commitlint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4.1.1 + - uses: wagoid/commitlint-github-action@v5.4.5 + name: Lint Commit Messages diff --git a/.github/workflows/lint-pr-title.yaml b/.github/workflows/lint-pr-title.yaml new file mode 100644 index 0000000000..bbe1d827d5 --- /dev/null +++ b/.github/workflows/lint-pr-title.yaml @@ -0,0 +1,69 @@ +name: "Lint PR Title" + +# Contents of this PR were copy-paste-modified from +# https://github.com/honeycombio/.github/blob/main/.github/workflows/validate-pr-title.yml + +on: + pull_request_target: + types: + - opened + - edited + - synchronize + +concurrency: + group: ${{ github.workflow }}-${{ github.event.pull_request.number }} # Ensure that only one instance of this workflow is running per Pull Request + cancel-in-progress: true # Cancel any previous runs of this workflow + +jobs: + main: + name: Validate PR title + runs-on: ubuntu-latest + permissions: + pull-requests: write + steps: + - uses: amannn/action-semantic-pull-request@v5.4.0 + id: lint_pr_title + name: "🤖 Check PR title follows conventional commit spec" + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + # Have to specify all types because `maint` and `rel` aren't defaults + types: | + fix + feat + chore + ci + docs + style + refactor + perf + test + # 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) + name: "📝 Add PR comment about using conventional commit spec" + uses: marocchino/sticky-pull-request-comment@v2 + with: + header: pr-title-lint-error + message: | + Thank you for contributing to the project! 🎉 + + 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. + + Make sure to prepend with `feat:`, `fix:`, or another option in the list below. + + Once you update the title, this workflow will re-run automatically and validate the updated title. + + 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 }} + name: "❌ Delete PR comment after title has been updated" + uses: marocchino/sticky-pull-request-comment@v2 + with: + header: pr-title-lint-error + delete: true