Skip to content

Commit

Permalink
squash: split up linters
Browse files Browse the repository at this point in the history
  • Loading branch information
arielvalentin committed Jan 17, 2024
1 parent 17610f8 commit 25bea35
Show file tree
Hide file tree
Showing 2 changed files with 65 additions and 6 deletions.
65 changes: 65 additions & 0 deletions .github/actions/lint-pr-title.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
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

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
6 changes: 0 additions & 6 deletions .github/workflows/commit-lint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,6 @@ jobs:
commitlint:
runs-on: ubuntu-latest
steps:
- uses: amannn/action-semantic-pull-request@v5.4.0
name: Lint PR Title
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
wip: true
- uses: actions/checkout@v4.1.1
- uses: wagoid/commitlint-github-action@v5.4.5
name: Lint Commit Messages

0 comments on commit 25bea35

Please sign in to comment.