Skip to content

fix: Reverse sync workflow #6

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.

Sign up for GitHub

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

Merged
danielfbm merged 1 commit into from
Jul 2, 2025
Merged

fix: Reverse sync workflow #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 33 additions & 10 deletions .github/workflows/reverse-sync-push.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,16 @@ jobs:
run: |
pr_number="${{ steps.check_pr_commit.outputs.pr_number }}"

echo "👀 Looking for PR $pr_number ..."


# Get PR information using GitHub API
pr_info=$(curl -s -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
"https://api.github.com/repos/${{ github.repository }}/pulls/$pr_number")


echo "👀 PR data $pr_info ..."

pr_title=$(echo "$pr_info" | jq -r '.title')
pr_author=$(echo "$pr_info" | jq -r '.user.login')
pr_url=$(echo "$pr_info" | jq -r '.html_url')
Expand Down Expand Up @@ -169,6 +175,9 @@ jobs:
echo "📑 Will only sync these paths: $SYNCED_PATHS"
git format-patch $parent_commit..$commit_sha --stdout -- $SYNCED_PATHS > changes.patch

echo "📋 Generated Patch: "
cat changes.patch

cd target-docs

# Apply the patch
Expand Down Expand Up @@ -205,12 +214,20 @@ jobs:
run: |
cd target-docs

echo "🔍 Checking for changes..."

git status

echo "=> Adding changes..."

git add .

echo "==> Checking if there are staged changes..."
if git diff --staged --quiet; then
echo "has_changes=false" >> $GITHUB_OUTPUT
echo "ℹ️ No changes to commit"
else
echo "=> Changes detected..."
echo "has_changes=true" >> $GITHUB_OUTPUT

pr_number="${{ steps.check_pr_commit.outputs.pr_number }}"
Expand All @@ -219,20 +236,26 @@ jobs:
pr_url="${{ steps.get_pr_info.outputs.pr_url }}"
commit_sha="${{ steps.check_pr_commit.outputs.commit_sha }}"

echo "=> Creating commit message..."
echo " - PR Number: $pr_number"
echo " - PR Title: $pr_title"
echo " - PR Author: $pr_author"
echo " - PR URL: $pr_url"
echo " - Commit SHA: $commit_sha"

# Create commit message with reverse sync marker
cat > commit_message.txt << EOF
[reverse-sync] Sync documentation changes from devops-pipelines-docs PR #$pr_number

This commit incorporates changes from external contributors to the devops-pipelines-docs repository.
echo "[reverse-sync] Sync documentation changes from devops-pipelines-docs PR #$pr_number" > commit_message.txt
echo "" >> commit_message.txt
echo "- Title: $pr_title" >> commit_message.txt
echo "- Author: $pr_author" >> commit_message.txt
echo "- URL: $pr_url" >> commit_message.txt
echo "- Commit: $commit_sha" >> commit_message.txt

📋 Original PR Details:
- Title: $pr_title
- Author: $pr_author
- URL: $pr_url
- Commit: $commit_sha
echo "=> Commit message:"
cat commit_message.txt

Comment on lines +239 to 257
Copy link
Contributor

@coderabbitai coderabbitai bot Jul 2, 2025

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Robust commit-message construction

Building the message line-by-line via echo can break if any field contains
newlines or leading - characters (common in markdown titles). A safer
heredoc keeps formatting intact:

-echo "[reverse-sync] Sync documentation changes from devops-pipelines-docs PR #$pr_number" > commit_message.txt
-echo "" >> commit_message.txt
-echo "- Title: $pr_title" >> commit_message.txt
-echo "- Author: $pr_author" >> commit_message.txt
-echo "- URL: $pr_url" >> commit_message.txt
-echo "- Commit: $commit_sha" >> commit_message.txt
+cat > commit_message.txt <<EOF
+[reverse-sync] Sync documentation changes from devops-pipelines-docs PR #$pr_number
+
+- Title: $pr_title
+- Author: $pr_author
+- URL: $pr_url
+- Commit: $commit_sha
+EOF

This avoids quoting issues and is easier to maintain.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
echo "=> Creating commit message..."
echo " - PR Number: $pr_number"
echo " - PR Title: $pr_title"
echo " - PR Author: $pr_author"
echo " - PR URL: $pr_url"
echo " - Commit SHA: $commit_sha"
# Create commit message with reverse sync marker
cat > commit_message.txt << EOF
[reverse-sync] Sync documentation changes from devops-pipelines-docs PR #$pr_number
This commit incorporates changes from external contributors to the devops-pipelines-docs repository.
echo "[reverse-sync] Sync documentation changes from devops-pipelines-docs PR #$pr_number" > commit_message.txt
echo "" >> commit_message.txt
echo "- Title: $pr_title" >> commit_message.txt
echo "- Author: $pr_author" >> commit_message.txt
echo "- URL: $pr_url" >> commit_message.txt
echo "- Commit: $commit_sha" >> commit_message.txt
📋 Original PR Details:
- Title: $pr_title
- Author: $pr_author
- URL: $pr_url
- Commit: $commit_sha
echo "=> Commit message:"
cat commit_message.txt
echo "=> Creating commit message..."
echo " - PR Number: $pr_number"
echo " - PR Title: $pr_title"
echo " - PR Author: $pr_author"
echo " - PR URL: $pr_url"
echo " - Commit SHA: $commit_sha"
# Create commit message with reverse sync marker
cat > commit_message.txt <<EOF
[reverse-sync] Sync documentation changes from devops-pipelines-docs PR #$pr_number
- Title: $pr_title
- Author: $pr_author
- URL: $pr_url
- Commit: $commit_sha
EOF
echo "=> Commit message:"
cat commit_message.txt
🤖 Prompt for AI Agents 
In .github/workflows/reverse-sync-push.yml around lines 239 to 257, the commit
message is constructed line-by-line using echo, which can cause issues if any
variables contain newlines or leading dashes. Replace the multiple echo
statements with a single heredoc block to build the commit message, preserving
formatting and avoiding quoting problems. Use the heredoc syntax to include all
variables directly, ensuring the message is robust and easier to maintain.

🔄 This is a reverse sync commit - it should not trigger forward sync.
EOF
echo "=> Committing changes..."

git commit -F commit_message.txt
rm commit_message.txt
Expand Down