Skip to content

fix(ci): keep docs sync branch aligned#2159

Open
wxyucs wants to merge 1 commit into
antgroup:mainfrom
wxyucs:fix/docs-sync-branch-alignment
Open

fix(ci): keep docs sync branch aligned#2159
wxyucs wants to merge 1 commit into
antgroup:mainfrom
wxyucs:fix/docs-sync-branch-alignment

Conversation

@wxyucs
Copy link
Copy Markdown
Collaborator

@wxyucs wxyucs commented Jun 8, 2026

Summary

  • Rebuild the website sync branch from origin/main before applying docs sync changes.
  • Force-push sync even when there are no content changes so stale sync commits are cleared.
  • Prevent repeated PRs from replaying the same old sync commit and creating empty-effect merge commits.

Verification

  • git diff --check -- .github/workflows/docs.yaml

Copilot AI review requested due to automatic review settings June 8, 2026 06:32
@wxyucs wxyucs added kind/improvement Code improvements (variable/function renaming, refactoring, etc. ) module/docs version/1.0 labels Jun 8, 2026
@wxyucs wxyucs self-assigned this Jun 8, 2026
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Note

Gemini is unable to generate a review for this pull request due to the file types involved not being currently supported.

@mergify
Copy link
Copy Markdown
Contributor

mergify Bot commented Jun 8, 2026

Merge Protections

Your pull request matches the following merge protections and will not be merged until they are valid.

🟢 Require kind label

Wonderful, this rule succeeded.
  • label~=^kind/

🟢 Require version label

Wonderful, this rule succeeded.
  • label~=^version/

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the docs sync GitHub Actions workflow to ensure the sync branch in vsag-io/vsag-io.github.io is consistently rebuilt from origin/main and force-updated, preventing stale/empty-effect sync commits from being replayed across repeated runs.

Changes:

  • Checkout the target website repo explicitly at main during the workflow run.
  • Recreate sync from origin/main before staging docs changes.
  • Force-push sync even when there are no content changes to clear stale history.

Comment thread .github/workflows/docs.yaml
Rebuild the website sync branch from the target main branch and stage deletions so stale sync commits are cleared reliably.

Signed-off-by: Xiangyu Wang <wxy407827@antgroup.com>
Assisted-by: OpenCode:gpt-5.5
@wxyucs wxyucs force-pushed the fix/docs-sync-branch-alignment branch from 15d332a to 3405d71 Compare June 8, 2026 08:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

kind/improvement Code improvements (variable/function renaming, refactoring, etc. ) module/docs size/XS version/1.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants