Skip to content

fix(ci): prevent duplicate PRs in publish-docs workflow #149

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
etserend wants to merge 2 commits into
base: main
Choose a base branch
from
+11 −12
Open

fix(ci): prevent duplicate PRs in publish-docs workflow #149

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f33bc0e
fix(ci): prevent duplicate PRs in publish-docs workflow
etserend Jul 27, 2026
fde008d
fix(ci): always push and update PR on every publish-docs run
etserend Jul 27, 2026
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
23 changes: 11 additions & 12 deletions .github/workflows/publish-docs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ jobs:

- name: Create a branch
working-directory: ./splunk-ao-docs
run: git checkout -b feat/update-docs-${GITHUB_REF_NAME}-${{ github.run_id }}
run: |
git fetch origin feat/update-docs-${GITHUB_REF_NAME} 2>/dev/null && git checkout feat/update-docs-${GITHUB_REF_NAME} || git checkout -b feat/update-docs-${GITHUB_REF_NAME}

- name: Update SDK docs
run: |
Expand All @@ -58,7 +59,6 @@ jobs:
cp -r ./splunk-ao-python/.generated_docs/reference ./splunk-ao-docs/sdk-api/python/

- name: Commit changes
id: commit
working-directory: ./splunk-ao-docs
env:
PAT: ${{ secrets.PAT_AO_DOC_AUTOMATION }}
Expand All @@ -67,17 +67,10 @@ jobs:
git config --global user.name "github-actions[bot]"
git remote set-url origin https://x-access-token:${PAT}@github.com/splunk/agent-observability-docs.git
git add .
if git diff --cached --quiet; then
echo "No doc changes to publish"
echo "has_changes=false" >> "$GITHUB_OUTPUT"
exit 0
fi
echo "has_changes=true" >> "$GITHUB_OUTPUT"
git commit -m "Updating docs from ${GITHUB_REF_NAME}-${{ github.run_id }}"
git push -u origin feat/update-docs-${GITHUB_REF_NAME}-${{ github.run_id }}
git commit --allow-empty -m "Updating docs from ${GITHUB_REF_NAME}"
git push origin feat/update-docs-${GITHUB_REF_NAME} --force

- name: Create PR
if: steps.commit.outputs.has_changes == 'true'
working-directory: ./splunk-ao-docs
env:
GH_TOKEN: ${{ secrets.PAT_AO_DOC_AUTOMATION }}
Expand All @@ -97,4 +90,10 @@ jobs:

**DO NOT** approve this PR until you have completed these checks.
run: |
gh pr create --title "Updated Python SDK docs" --body "$PR_BODY"
BRANCH_NAME=feat/update-docs-${GITHUB_REF_NAME}
EXISTING_PR=$(gh pr list --base main --head $BRANCH_NAME --state open --json number --jq '.[0].number')
if [ -n "$EXISTING_PR" ]; then
echo "PR #$EXISTING_PR already open for branch $BRANCH_NAME — updated via force push"
else
gh pr create --title "Updated Python SDK docs" --body "$PR_BODY"
fi
Loading