Skip to content

Add the fork-sync schema example for mirrors - #223

Merged
Blogbotana merged 1 commit into
Apibim-com:masterfrom
axisrow:docs/fork-sync-schema-example
Oct 24, 2026
Merged

Blogbotana merged 1 commit into
Apibim-com:masterfrom
axisrow:docs/fork-sync-schema-example

Conversation

@axisrow

@axisrow axisrow commented Oct 24, 2026 •

Copy link
Copy Markdown
Collaborator

What this changes

Mirrors (forks) keep their own master aligned with this repository — see
#206 for the sync context. Upstream has no write access to any mirror, so a
runnable sync script cannot work from here and is not committed here.
Instead this ships:

  • tools/sync.schema.example — the shape of a correct mirror sync (fetch,
    fast-forward of a stale local master, no-commit merge, the quality gate
    while the merge is still uncommitted, non-force push), marked as an
    example, not runnable code;
  • a CONTRIBUTING.md paragraph saying the script is given only as an example
    and that each mirror keeps its own implementation with its own
    credentials.

How you verified it

  • The example file has no shebang, no repository URLs, no credentials: it is
    a schema, not a script (the .example extension is deliberate, so no
    tooling mistakes it for something to run).
  • The CONTRIBUTING.md paragraph links the schema and points mirror authors
    at the step 3 quality gate.

🤖 Generated with Claude Code

Verified final integration status

Earlier preparation/draft notes in this historical description are superseded by GitHub's final state: merged into master on 2026-10-24T16:29:29Z. Independently fetched integration commit 6afef0f: Add the fork-sync schema example for mirrors (#223). This records delivery of this PR's limited slice, not completion of open acceptance gates.

Issue tracking

Fixes #389

Mirrors keep their own master aligned with this repository, but upstream has
no write access to any mirror, so a runnable sync script cannot work from
here and is not committed here. Commit the shape instead:
tools/sync.schema.example records the invariants and phases of a correct
sync (fetch, fast-forward, no-commit merge, the quality gate while the merge
is still uncommitted, non-force push), and CONTRIBUTING.md says the script
is given only as an example and stays inside each mirror.

Co-Authored-By: Claude Code <[email protected]>
@axisrow
axisrow requested a review from Blogbotana as a code owner October 24, 2026 14:57
@Blogbotana
Blogbotana merged commit 6afef0f into Apibim-com:master Oct 24, 2026
34 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

PR #223: Add the fork-sync schema example for mirrors

2 participants