Skip to content

gha/sync-cli-docs: Ignore explicitly closed versions #24101

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

Open
vvoland wants to merge 1 commit into
base: main
Choose a base branch
from
Open

gha/sync-cli-docs: Ignore explicitly closed versions #24101

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
12 changes: 10 additions & 2 deletions .github/workflows/sync-cli-docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,14 +108,22 @@ jobs:
> **Reviewer:** Please close and reopen this PR to trigger CI checks.
> See: https://docs.github.com/en/actions/how-tos/write-workflows/choose-when-workflows-run/trigger-a-workflow#triggering-a-workflow-from-a-workflow
run: |
# Check for existing PR from this branch
EXISTING_PR=$(gh pr list --state open --head "$BRANCH_NAME" --json url --jq ".[0].url")
# Check for existing open PR from this branch
EXISTING_PR=$(gh pr list --state open --head "$BRANCH_NAME" --json url --jq ".[0].url // empty")

if [ -n "$EXISTING_PR" ]; then
echo "Updating existing PR: $EXISTING_PR" >> "$GITHUB_STEP_SUMMARY"
git push -u origin "$BRANCH_NAME" --force
gh pr edit "$EXISTING_PR" --title "$PR_TITLE" --body "$PR_BODY"
else
# Check if a closed PR with the same title already exists
Copy link
Contributor

@github-actions github-actions bot Feb 9, 2026

Choose a reason for hiding this comment

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

Comment could be more informative

The comment describes what is being checked but not why it's necessary. Consider clarifying the intent:

Suggested change
# Check if a closed PR with the same title already exists
# Check if a closed PR with the same title already exists (avoid reopening intentionally closed PRs)

This helps future maintainers understand that closed PRs represent an intentional decision, not just a past state.

CLOSED_PR=$(gh pr list --state closed --search "$PR_TITLE in:title" --json url --jq ".[0].url // empty")
if [ -n "$CLOSED_PR" ]; then
echo "A closed PR already exists for this version: $CLOSED_PR" >> "$GITHUB_STEP_SUMMARY"
Copy link
Contributor

@github-actions github-actions bot Feb 9, 2026

Choose a reason for hiding this comment

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

Message could be clearer for workflow debugging

The current message doesn't explicitly state what action is being taken. Consider making it more explicit:

Suggested change
echo "A closed PR already exists for this version: $CLOSED_PR" >> "$GITHUB_STEP_SUMMARY"
echo "Skipping PR creation: closed PR already exists for this version: $CLOSED_PR" >> "$GITHUB_STEP_SUMMARY"

This immediately tells someone viewing the workflow summary what happened and why, improving debugging experience.

echo "Skipping PR creation."
exit 0
fi

echo "Creating new PR" >> "$GITHUB_STEP_SUMMARY"
git push -u origin "$BRANCH_NAME"
gh pr create \
Expand Down
Loading