mirror of
https://github.com/paradigmxyz/reth.git
synced 2026-01-14 01:38:05 -05:00
d8ade5af38
Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
87 lines
2.5 KiB
YAML
87 lines
2.5 KiB
YAML
name: Pull Request
|
|
|
|
on:
|
|
pull_request:
|
|
types:
|
|
- opened
|
|
- reopened
|
|
- edited
|
|
- synchronize
|
|
|
|
permissions:
|
|
pull-requests: read
|
|
contents: read
|
|
|
|
jobs:
|
|
conventional-title:
|
|
name: Validate PR title is Conventional Commit
|
|
runs-on: ubuntu-latest
|
|
permissions:
|
|
pull-requests: write
|
|
steps:
|
|
- name: Check title
|
|
id: lint_pr_title
|
|
uses: amannn/action-semantic-pull-request@v6
|
|
env:
|
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
with:
|
|
types: |
|
|
feat
|
|
fix
|
|
chore
|
|
test
|
|
bench
|
|
perf
|
|
refactor
|
|
docs
|
|
ci
|
|
revert
|
|
deps
|
|
continue-on-error: true
|
|
- name: Add PR Comment for Invalid Title
|
|
if: steps.lint_pr_title.outcome == 'failure'
|
|
uses: marocchino/sticky-pull-request-comment@v2
|
|
with:
|
|
header: pr-title-lint-error
|
|
message: |
|
|
Your PR title doesn't follow the Conventional Commit guidelines.
|
|
|
|
**Example of valid titles:**
|
|
- `feat: add new user login`
|
|
- `fix: correct button size`
|
|
- `docs: update README`
|
|
|
|
**Usage:**
|
|
- `feat`: Introduces a new feature
|
|
- `fix`: Patches a bug
|
|
- `chore`: General maintenance tasks or updates
|
|
- `test`: Adding new tests or modifying existing tests
|
|
- `bench`: Adding new benchmarks or modifying existing benchmarks
|
|
- `perf`: Performance improvements
|
|
- `refactor`: Changes to improve code structure
|
|
- `docs`: Documentation updates
|
|
- `ci`: Changes to CI/CD configurations
|
|
- `revert`: Reverts a previously merged PR
|
|
- `deps`: Updates dependencies
|
|
|
|
**Breaking Changes**
|
|
|
|
Breaking changes are noted by using an exclamation mark. For example:
|
|
- `feat!: changed the API`
|
|
- `chore(node)!: Removed unused public function`
|
|
|
|
**Help**
|
|
|
|
For more information, follow the guidelines here: https://www.conventionalcommits.org/en/v1.0.0/
|
|
|
|
- name: Remove Comment for Valid Title
|
|
if: steps.lint_pr_title.outcome == 'success'
|
|
uses: marocchino/sticky-pull-request-comment@v2
|
|
with:
|
|
header: pr-title-lint-error
|
|
delete: true
|
|
|
|
- name: Fail workflow if title invalid
|
|
if: steps.lint_pr_title.outcome == 'failure'
|
|
run: exit 1
|