-
Notifications
You must be signed in to change notification settings - Fork 247
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix_: separate commit message check #5773
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
8880f90
chore_: add github action conventional commits
igor-sirotin 1d1d162
chore_: remove commit check from tests run
igor-sirotin 1d650b9
fix_: continue checking commits when breaking change found
igor-sirotin 7c52396
fix_: don't run check on pr edit
igor-sirotin File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
name: "Conventional Commits" | ||
|
||
on: | ||
pull_request: | ||
types: | ||
- opened | ||
- synchronize | ||
jobs: | ||
main: | ||
name: Validate format | ||
runs-on: ubuntu-latest | ||
permissions: | ||
pull-requests: write | ||
steps: | ||
- uses: actions/checkout@v4 | ||
with: | ||
ref: ${{ env.GITHUB_HEAD_REF }} | ||
fetch-tags: true | ||
|
||
- name: Fetch tags | ||
run: | | ||
git fetch --tags --quiet | ||
git checkout origin/${GITHUB_HEAD_REF} | ||
|
||
- name: Check commit message | ||
id: check_commit_message | ||
run: | | ||
set +e | ||
|
||
output=$(./_assets/scripts/commit_check.sh 2>&1) | ||
exit_code=$? | ||
echo "exit_code=$exit_code" >> $GITHUB_OUTPUT | ||
|
||
if [[ $exit_code -ne 0 ]]; then | ||
EOF=$(dd if=/dev/urandom bs=15 count=1 status=none | base64) | ||
echo "error_message<<$EOF" >> "$GITHUB_ENV" | ||
echo "$output" >> "$GITHUB_ENV" | ||
echo "$EOF" >> "$GITHUB_ENV" | ||
else | ||
has_breaking_changes=$(echo "$output" | sed -n '2p') | ||
echo "has_breaking_changes=$has_breaking_changes" >> $GITHUB_OUTPUT | ||
fi | ||
|
||
- name: "Publish failed commit messages" | ||
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.check_commit_message.outputs.exit_code != 0) | ||
with: | ||
header: commit-message-lint-error | ||
message: | | ||
Thank you for opening this pull request! | ||
|
||
We require commits to follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/), but with `_` for non-breaking changes. | ||
And it looks like your PR needs to be adjusted. | ||
|
||
Details: | ||
``` | ||
${{ env.error_message }} | ||
``` | ||
|
||
- name: "Publish breaking changes message" | ||
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.check_commit_message.outputs.exit_code == 0 && steps.check_commit_message.outputs.has_breaking_changes == 'true') | ||
with: | ||
header: commit-message-lint-error | ||
message: | | ||
Thank you for opening this pull request! | ||
|
||
Looks like you have BREAKING CHANGES in your PR. | ||
Please make sure to update [status-desktop](https://github.com/status-im/status-desktop) and [status-mobile](https://github.com/status-im/status-mobile) clients accordingly. | ||
|
||
# Delete a previous comment when the issue has been resolved | ||
- name: "Delete previous comment" | ||
if: ${{ steps.check_commit_message.outputs.exit_code == 0 && steps.check_commit_message.outputs.has_breaking_changes == 'false' }} | ||
uses: marocchino/sticky-pull-request-comment@v2 | ||
with: | ||
header: commit-message-lint-error | ||
delete: true |
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
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This
break
is wrong. We should check all commits.