forked from vllm-project/vllm
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[CI/Build] Automate PR body text cleanup
Add a github workflow that will prune tempalte text from PRs. This will help ensure that the PR body is appropriate for inclusion in the squashed commit when a PR is merged. Signed-off-by: Russell Bryant <[email protected]>
- Loading branch information
Showing
2 changed files
with
54 additions
and
0 deletions.
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,31 @@ | ||
#!/bin/bash | ||
|
||
# ensure 1 argument is passed | ||
if [ "$#" -ne 1 ]; then | ||
echo "Usage: $0 <pr_number>" | ||
exit 1 | ||
fi | ||
|
||
PR_NUMBER=$1 | ||
OLD=/tmp/orig_pr_body.txt | ||
NEW=/tmp/new_pr_body.txt | ||
|
||
gh pr view --json body --template "{{.body}}" "${PR_NUMBER}" > "${OLD}" | ||
cp "${OLD}" "${NEW}" | ||
|
||
# Remove all lines after and including "**BEFORE SUBMITTING, PLEASE READ THE CHECKLIST BELOW AND FILL IN THE DESCRIPTION ABOVE**" | ||
sed -i '/\*\*BEFORE SUBMITTING, PLEASE READ THE CHECKLIST BELOW AND FILL IN THE DESCRIPTION ABOVE\*\*/,$d' "${NEW}" | ||
|
||
# Remove "FIX #xxxx (*link existing issues this PR will resolve*)" | ||
sed -i '/FIX #xxxx.*$/d' "${NEW}" | ||
|
||
# Remove "FILL IN THE PR DESCRIPTION HERE" | ||
sed -i '/FILL IN THE PR DESCRIPTION HERE/d' "${NEW}" | ||
|
||
# Run this only if ${NEW} is different than ${OLD} | ||
if ! cmp -s "${OLD}" "${NEW}"; then | ||
echo "Updating PR body" | ||
gh pr edit --body-file "${NEW}" "${PR_NUMBER}" | ||
else | ||
echo "No changes needed" | ||
fi |
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,23 @@ | ||
name: Cleanup PR Body | ||
|
||
on: | ||
pull_request: | ||
types: [opened, edited, synchronize] | ||
|
||
jobs: | ||
update-description: | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout repository | ||
uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4.2.1 | ||
|
||
- name: Set up Python | ||
uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0 | ||
with: | ||
python-version: '3.12' | ||
|
||
- name: Update PR description | ||
env: | ||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
run: .github/scripts/cleanup_pr_body.sh "${{ github.event.number }}" |