Skip to content
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

add an action to remove trailing spaces when opening a PR #551

Merged
merged 1 commit into from
Dec 11, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions .github/workflows/formt-pr-files.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: Format PR Files

on:
pull_request:
types:
- opened
paths:
- '**/*.md' # Trigger workflow only when .md files are modified in the PR

jobs:
whitespace:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Set up Git config
run: |
git config --global user.name "miyaliu666"
git config --global user.email "[email protected]"

- name: Remove trailing whitespaces from Markdown files
run: |
echo "Target branch: ${{ github.event.pull_request.base.ref }}"
echo "Head branch: ${{ github.event.pull_request.head.ref }}"

# Get the base commit between the target branch (main) and the source branch (HEAD)
base_branch="${{ github.event.pull_request.base.ref }}"
head_branch="${{ github.event.pull_request.head.ref }}"

git fetch origin $base_branch
git fetch origin $head_branch

base_commit=$(git merge-base origin/$base_branch origin/$head_branch)
echo "Base commit: $base_commit"

# Get the changed files in the current PR
echo "Checking changes in PR..."
files=$(git diff --name-only $base_commit origin/$head_branch)
echo "Changed files: $files"

# Filter out .md files
file=$(echo "$files" | grep '\.md$')
echo "Filtered .md file: $file"

if [ -n "$file" ]; then
echo "Processing file: $file"
# Remove trailing spaces from each line in the file
sed -i 's/ $//g' "$file"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
sed -i 's/ $//g' "$file"
pnpx prettier --write "$file"

Prettier can fix all kinds of formatting issues including the tail spaces.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your comment, @TechQuery.

I think we eventually want to utilize Prettier for formatting, but what we are currently trying to do is a little different. We want to intentionally make changes to every lines just to make it easier for proofreaders to comment on any lines in PRs.

There might be a better solution, but let's try this way first.

# Switch to the source branch and push the changes
git checkout $head_branch
git add "$file"
git commit -m "Remove trailing spaces from $file"
git push origin $head_branch
else
echo "No .md files found or no changes to commit."
fi