feat_: improve PR commit messages processing (#5835)
* fix_: commit-messages github action * fix_: prevent -> avoid * fix_: use curly braces
This commit is contained in:
parent
ff7de68845
commit
946ee4e496
|
@ -27,19 +27,28 @@ jobs:
|
||||||
run: |
|
run: |
|
||||||
set +e
|
set +e
|
||||||
|
|
||||||
output=$(./_assets/scripts/commit_check.sh 2>&1)
|
output=$(./_assets/scripts/commit_check.sh 2>&1)
|
||||||
exit_code=$?
|
exit_code=$?
|
||||||
echo "exit_code=$exit_code" >> $GITHUB_OUTPUT
|
|
||||||
|
echo "${output}" | sed '$d'
|
||||||
|
echo "has_breaking_changes=${has_breaking_changes}"
|
||||||
|
|
||||||
|
echo "exit_code=${exit_code}" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
has_breaking_changes=$(echo "${output}" | tail -n 1)
|
||||||
|
echo "has_breaking_changes=${has_breaking_changes}" >> $GITHUB_OUTPUT
|
||||||
|
|
||||||
|
invalid_commit_messages=$(echo "${output}" | sed '1d;$d')
|
||||||
|
invalid_commit_messages=$(echo "${output}" | sed '1d;$d')
|
||||||
|
invalid_commit_messages=$(echo "${invalid_commit_messages}" | sed 's/\x1b\[[0-9;]*m//g') # Remove color codes
|
||||||
|
invalid_commit_messages=$(echo "${invalid_commit_messages}" | sed 's/^Commit message is ill-formed: //') # Remove prefix
|
||||||
|
|
||||||
if [[ $exit_code -ne 0 ]]; then
|
if [[ $exit_code -ne 0 ]]; then
|
||||||
invalid_commit_messages=$(echo $output | sed '1d;$d')
|
|
||||||
EOF=$(dd if=/dev/urandom bs=15 count=1 status=none | base64)
|
EOF=$(dd if=/dev/urandom bs=15 count=1 status=none | base64)
|
||||||
echo "error_message<<$EOF" >> "$GITHUB_ENV"
|
echo "error_message<<$EOF" >> "$GITHUB_ENV"
|
||||||
echo "invalid_commit_messages" >> "$GITHUB_ENV"
|
echo "${invalid_commit_messages}" >> "$GITHUB_ENV"
|
||||||
echo "$EOF" >> "$GITHUB_ENV"
|
echo "$EOF" >> "$GITHUB_ENV"
|
||||||
else
|
|
||||||
has_breaking_changes=$(echo "$output" | tail -n 1)
|
|
||||||
echo "has_breaking_changes=$has_breaking_changes" >> $GITHUB_OUTPUT
|
|
||||||
fi
|
fi
|
||||||
|
|
||||||
- name: "Publish failed commit messages"
|
- name: "Publish failed commit messages"
|
||||||
|
@ -50,12 +59,8 @@ jobs:
|
||||||
with:
|
with:
|
||||||
header: commit-message-lint-error
|
header: commit-message-lint-error
|
||||||
message: |
|
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.
|
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.
|
Please fix these commit messages:
|
||||||
|
|
||||||
Details:
|
|
||||||
```
|
```
|
||||||
${{ env.error_message }}
|
${{ env.error_message }}
|
||||||
```
|
```
|
||||||
|
@ -68,10 +73,14 @@ jobs:
|
||||||
with:
|
with:
|
||||||
header: commit-message-lint-error
|
header: commit-message-lint-error
|
||||||
message: |
|
message: |
|
||||||
Thank you for opening this pull request!
|
|
||||||
|
|
||||||
Looks like you have BREAKING CHANGES in your PR.
|
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.
|
Please make sure to follow [💔How to introduce breaking changes](https://www.notion.so/How-to-introduce-breaking-changes-ded9ec2d91464a46a2593c0d8de62fbe?pvs=4) guide:
|
||||||
|
|
||||||
|
### Check-list
|
||||||
|
|
||||||
|
- [ ] Tried to avoid this breaking change
|
||||||
|
- [ ] Updated [status-desktop](https://github.com/status-im/status-desktop)
|
||||||
|
- [ ] Updated [status-mobile](https://github.com/status-im/status-mobile)
|
||||||
|
|
||||||
# Delete a previous comment when the issue has been resolved
|
# Delete a previous comment when the issue has been resolved
|
||||||
- name: "Delete previous comment"
|
- name: "Delete previous comment"
|
||||||
|
@ -80,3 +89,25 @@ jobs:
|
||||||
with:
|
with:
|
||||||
header: commit-message-lint-error
|
header: commit-message-lint-error
|
||||||
delete: true
|
delete: true
|
||||||
|
|
||||||
|
- name: "Mark as failed"
|
||||||
|
if: steps.check_commit_message.outputs.exit_code != 0
|
||||||
|
uses: actions/github-script@v7
|
||||||
|
with:
|
||||||
|
script: |
|
||||||
|
core.setFailed("Some commit messages are ill-formed")
|
||||||
|
|
||||||
|
- name: "Update breaking changes label"
|
||||||
|
if: always()
|
||||||
|
run: |
|
||||||
|
if [[ $ADD_LABEL == 'true' ]]; then
|
||||||
|
command="--add-label"
|
||||||
|
else
|
||||||
|
command="--remove-label"
|
||||||
|
fi
|
||||||
|
gh issue edit "$NUMBER" $command "breaking change"
|
||||||
|
env:
|
||||||
|
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||||
|
GH_REPO: ${{ github.repository }}
|
||||||
|
NUMBER: ${{ github.event.pull_request.number }}
|
||||||
|
ADD_LABEL: ${{ steps.check_commit_message.outputs.has_breaking_changes == 'true' }}
|
|
@ -28,7 +28,7 @@ parse_commits() {
|
||||||
is_breaking_change=true
|
is_breaking_change=true
|
||||||
fi
|
fi
|
||||||
else
|
else
|
||||||
echo -e "${YLW}Commit message is not well-formed:${RST} \"$message\""
|
echo -e "${YLW}Commit message is ill-formed:${RST} $message"
|
||||||
exit_code=1
|
exit_code=1
|
||||||
fi
|
fi
|
||||||
done < <(git log --format=%s "$start_commit".."$end_commit")
|
done < <(git log --format=%s "$start_commit".."$end_commit")
|
||||||
|
|
|
@ -37,13 +37,10 @@ calculate_new_version() {
|
||||||
# Parse commits to determine if there are breaking changes
|
# Parse commits to determine if there are breaking changes
|
||||||
output=$(parse_commits "$latest_tag" "$target_commit")
|
output=$(parse_commits "$latest_tag" "$target_commit")
|
||||||
exit_code=$?
|
exit_code=$?
|
||||||
|
echo "$output" | sed '$d' >&2 # Skip the last line, it contains the breaking change flag
|
||||||
|
|
||||||
a=$(echo "$output" | sed '$d')
|
|
||||||
is_breaking_change=$(echo "$output" | tail -n 1)
|
is_breaking_change=$(echo "$output" | tail -n 1)
|
||||||
|
|
||||||
echo "$a" >&2
|
|
||||||
|
|
||||||
|
|
||||||
if [[ $is_breaking_change == 'true' ]]; then
|
if [[ $is_breaking_change == 'true' ]]; then
|
||||||
echo -e "${YLW}Breaking change detected${RST}" >&2
|
echo -e "${YLW}Breaking change detected${RST}" >&2
|
||||||
fi
|
fi
|
||||||
|
|
Loading…
Reference in New Issue