Skip to content

ci: allow docs-sync to be triggered manually #17

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
evanorti merged 1 commit into from
Aug 25, 2026
Merged

ci: allow docs-sync to be triggered manually #17

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
4 changes: 4 additions & 0 deletions .github/workflows/docs-sync.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ on:
- main
paths:
- "docs/**"
# Manual trigger. Needed because the push trigger only fires on docs/** changes,
# so a workflow-only fix cannot re-run the sync, and a sync PR left stale by a
# failed run has no way to catch up until the next docs edit.
workflow_dispatch:

@greptile-apps greptile-apps Bot Aug 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Manual dispatch uses selected branch

When an operator dispatches this workflow from a non-main branch, the unpinned source checkout transforms that branch's documentation and commits it to a docs-site PR targeting main, causing stale or feature-branch content to enter the sync PR; an older branch without the transform script instead makes the run fail.

Comment on lines +14 to +17

@greptile-apps greptile-apps Bot Aug 25, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Manual trigger lacks changelog entry

This workflow change has no corresponding entry in the Unreleased changelog, despite the repository requirement to document every change, so the release history omits the newly supported manual docs-sync operation.

Context Used: CLAUDE.md (source)

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!


# Serialize runs. Two overlapping runs would each check out the same revision of
# the open sync branch, commit divergently, and the loser's push would be
Expand Down