Skip to content

Commit

Permalink
chore: Simplify PR linter (#413)
Browse files Browse the repository at this point in the history
Signed-off-by: Dave Skender <[email protected]>
  • Loading branch information
DaveSkender authored Jan 4, 2025
1 parent 7b23a9d commit 09b0a4e
Showing 1 changed file with 42 additions and 34 deletions.
76 changes: 42 additions & 34 deletions .github/workflows/lint-pull-request.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
name: "Pull request"
name: Pull request

on:
pull_request_target:
pull_request:
types:
- opened
- edited
- synchronize
- unlabeled

permissions:
pull-requests: write
Expand All @@ -14,59 +14,67 @@ jobs:
main:
name: lint PR title
runs-on: ubuntu-latest

steps:
- uses: amannn/action-semantic-pull-request@v5
id: lint_pr_title
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:

# Configure additional validation for the subject based on a regex.
# We enforce that the subject starts with an uppercase character.
subjectPattern: ^([A-Z]).+$

# If `subjectPattern` is configured, you can use this property to override
# the default error message that is shown when the pattern doesn't match.
# The variables `subject` and `title` can be used within the message.
subjectPatternError: >
The subject "**{subject}**" found in the pull request title "*{title}*"
didn't match the configured pattern. Please ensure that the subject
starts with an uppercase character.
# If the PR contains one of these newline-delimited labels, the
# validation is skipped. If you want to rerun the validation when
# labels change, you might want to use the `labeled` and `unlabeled`
# event triggers in your workflow.
The subject "**{subject}**" must start with an uppercase character.
Example: "Add feature" instead of "add feature"
ignoreLabels: |
bot
dependencies
- 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: >
### Hey there and thank you for opening this pull request! 👋🏼
message: |
### ⚠️ Invalid Pull Request title
Your PR title must follow the format: `type: Subject` where:
- `type` is one of the conventional commit types (in lowercase)
- `Subject` starts with an uppercase letter
It looks like your proposed **_Pull request title_** needs to be adjusted.
> [!CAUTION]
> ${{ steps.lint_pr_title.outputs.error_message }}
>🚩 **Error** » ${{ steps.lint_pr_title.outputs.error_message }}
#### Valid examples
#### Pull request title naming convention
- `feat: Add API endpoint for market data`
- `fix: Resolve WebSocket connection issues`
- `chore: Update NuGet dependencies`
Our PR title name taxonomy is `type: Subject`, where **type** is typically
*feat*, *fix*, or *chore*, and **subject** is a phrase (proper noun) that starts
with a capitalized letter. The *chore* type usually has a subject that starts
with an action verb like *Add* or *Update*. Examples:
<details>
<summary>see more valid examples</summary>
- _feat: Admin portal login_
- _fix: Divide by zero bug in SMA_
- _chore: Update packages_
- _docs: Improve setup guidance_
#### Features & fixes
- `feat: Add API endpoint for market data`
- `fix: Resolve WebSocket connection issues`
See the [Conventional Commits specification](https://www.conventionalcommits.org) for more information.
#### Code quality
- `style: Format trading strategy classes`
- `refactor: Restructure trading engine components`
- `perf: Optimize trade order execution flow`
#### Documentation & testing
- `docs: Update API documentation`
- `test: Add unit tests for sign-in flow`
#### Infrastructure
- `build: Update .NET SDK version to 8.0`
- `ci: Add workflow for performance testing`
- `chore: Update NuGet dependencies`
#### Other
- `revert: Remove faulty market data provider`
See [Conventional Commits](https://www.conventionalcommits.org) for more details.
</details>
# Delete a previous comment when the issue has been resolved
- if: ${{ steps.lint_pr_title.outputs.error_message == null }}
Expand Down

0 comments on commit 09b0a4e

Please sign in to comment.