chore(ci): Update pull request workflow to include error message on wrong conventional title #526
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
kevaundray
changed the title
|
the default github token/action settings does not have write permissions, hence the error. This PR makes the dev-ux better but it not 100% necessary |
kevaundray
changed the title
phated
reviewed
Jun 13, 2023
Comment on lines
+31
to
+50
| - uses: marocchino/sticky-pull-request-comment@v2 | ||
| 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! 👋🏼 | ||
|
|
||
| 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. | ||
|
|
||
| Details: | ||
|
|
||
| ``` | ||
| ${{ steps.lint_pr_title.outputs.error_message }} | ||
| ``` | ||
|
|
||
| - if: ${{ steps.lint_pr_title.outputs.error_message == null }} | ||
| uses: marocchino/sticky-pull-request-comment@v2 | ||
| with: | ||
| header: pr-title-lint-error | ||
| delete: true |
There was a problem hiding this comment.
If you are trying to create a comment, it needs write permissions, and if you are giving write permissions to a workflow, it can't run on pull_request because someone could exfiltrate the token. You need to use pull_request_target with any write permissions.
kevaundray
changed the title
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.
Description
Please provide a paragraph or two giving a summary of the change, including relevant motivation and context.
Checklist:
/markdown/specshave been updated.@briefdescribing the intended functionality.