feat: add error comment in lint-pr-title.yml #175
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Krishks369
requested review from
derberg,
quetzalliwrites,
fmvilas,
KhudaDad414 and
asyncapi-bot-eve
as code owners
derberg
requested changes
Aug 22, 2022
.github/workflows/lint-pr-title.yml
Outdated
| with: | ||
| subjectPattern: ^(?![A-Z]).+$ | ||
| subjectPatternError: | | ||
| The subject "{subject}" found in the pull request title "{title}" should start with a lowercase character. | ||
|
|
||
| # Comments the error message from the above lint_pr_title action and deletes the comment when the linting is correct |
| with: | ||
| header: comment | ||
| message: | | ||
| ``` |
There was a problem hiding this comment.
Looks great. I would only suggest we add some additional message, from our side, with some emoji, not to have such a raw output as they provide in the action that we use.
So the error from amannn/action-semantic-pull-request is shown as code, but before it, we should have some highlight, like maybe Hey there 👋🏼 thanks for opening the PR but we need you to adjust the title of the pull request. We require all PRs to follow Conventional Commits specification. More details 👇🏼
you know what I mean?
| name: delete the comment | ||
| uses: marocchino/sticky-pull-request-comment@v2 | ||
| with: | ||
| header: comment |
|
@Krishks369 hey man, need a hand? |
|
Hey @derberg ,do we need to refine this PR also? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I have added feature in the lint-pr-title.yml file to comment on the lint errors in the title while PR is created
Three scenarios are there for the workflow
When the PR title is not in the correct format i.e when it is apart from titles like
feat,fixetc. It works like it has in this PR .When the PR title is not found or the PR subject starts in capital, then it works like in this PR
When the lint is corrected after the comment, the comment is then deleted from the PR, as mentioned in https://github.com/marocchino/sticky-pull-request-comment
Although the action used for linting the title is https://github.com/amannn/action-semantic-pull-request I have forked and used this feature before it got merged in the main action. So temporarily it uses https://github.com/Krishks369/action-semantic-pull-request.