8.8 KiB
8.8 KiB
Changelog
2.1.0
Breaking Changes
None.
Features
adoptcommand for non-destructive existing subrepos:josh-sync adopt <target>imports existing subrepo content into the monorepo, waits for the import PR to merge, then creates an adoption merge commit on the subrepo. The adoption merge uses the Josh-filtered monorepo commit as first parent and the existing subrepo commit as second parent, preserving old subrepo history while establishing Josh-compatible ancestry.- Resumable adoption state: adoption progress is stored on
josh-sync-stateat<target>/adopt.json, separate from sync and onboard state.
Safety
- Adoption requires the subrepo tree to match the Josh-filtered monorepo tree before creating the merge commit.
- Adoption pushes with a normal fast-forward push only. It never force-pushes.
2.0.0
Breaking Changes
schema_version: 2is now required. v1 configs are rejected with a migration pointer. Addschema_version: 2at the top of.josh-sync.yml.josh.monorepo_urlis now required. Set it to your monorepo's git clone URL —git@host:org/repo.git(SSH),ssh://..., orhttps://host/org/repo.git. Removes the silent inference of the gitea host from the first target'ssubrepo_url, which silently misbehaved when the monorepo and a target lived on different gitea instances. See ADR-012.MONOREPO_APIderivation changed. The default is nowhttps://{monorepo_url's host}/api/v1/repos/{monorepo_path}. The env-var override is preserved as an escape hatch for custom API endpoints.
Migration
# Before (v1.x)
josh:
proxy_url: "https://josh.example.com"
monorepo_path: "org/monorepo"
# After (v2.0.0)
schema_version: 2
josh:
proxy_url: "https://josh.example.com"
monorepo_path: "org/monorepo"
monorepo_url: "git@gitea.example.com:org/monorepo.git" # required
monorepo_auth: "ssh" # optional, default "https"
If you previously set the MONOREPO_API env var to work around the first-target-host bug, you can remove it — the new derivation gets it right from monorepo_url.
Features
- Multi-host configs supported. The monorepo and any subrepo may live on different gitea instances. Target ordering no longer affects how the monorepo's host is resolved.
- SSH clone of the monorepo via
monorepo_auth: ssh. Uses the user's ssh-agent /~/.ssh/config; no token required for the clone itself. PR creation still usesGITEA_TOKEN. - Symmetric config shape. Monorepo and subrepos now both declare a URL plus an auth method.
Fixes
- First-target ordering no longer load-bearing on
MONOREPO_APIderivation (wasgitea_host=.[0].gitea_hostin v1.x).
1.5.0
Breaking Changes
None.
Features
--forceflag for reverse sync:josh-sync sync --reverse --forcebypasses the PR step and force-pushes the subrepo's state directly onto the monorepo branch. Also skips theskip-dirtyguard. Only valid with--reverse. Returns statusforced.
1.4.0
Breaking Changes
None.
Features
schema_versionconfig field: New optional integer field in.josh-sync.yml. Defaults to1when absent. josh-sync fails fast with a clear error if an unsupported version is present — safe path for future config migrations without silent misinterpretation.
Fixes
- Linearize fallback applying wrong diff: Fallback for failed
cherry-pickwas diffing fromHEADto the commit's full tree instead of from the commit's own parent, causing unrelated file deletions. Now diffs from the commit's own parent (${sha}^/${sha}^1). - Linearize fallback for already-applied merge commits: When
cherry-pick -m 1produces an empty result because a merge's changes were already applied by a prior cherry-pick, the commit is now skipped instead of attempting a failinggit apply. - Linearize fallback output: Suppressed git noise from cherry-pick, checkout, and commit during linearization; added delimiters and consistent indented log lines.
Docs
- Workflow guide: removed redundant step-by-step subsections (table already covers them); tightened ADR-011 alternatives; removed stale version pins.
- README: added Versioning section with semver policy table and floating tag explanation.
1.3.0
Breaking Changes
None.
Features
- Linearize fallback for reverse sync: When josh-proxy rejects a push due to unmappable merge commits, reverse sync automatically falls back to linearizing the history — cherry-picking regular commits individually and squashing only the problematic merge commits via
cherry-pick -m 1. Preserves individual commit granularity while handling complex merge topologies that josh cannot map. PR body notes when linearization was used.
Fixes
- Reverse sync human commit detection: Fixed
--ancestry-pathreturning empty whenmono-filteredhas advanced past the last forward sync. Any monorepo commit (even outside the subfolder) causes josh to create a new filtered commit, breaking the ancestry path to subrepo HEAD. Now usesgit merge-baseto find the last connected point. - State not updated on false skip: When trees differ but no human commits are found, reverse sync now returns
skip-dirtyinstead ofskip. State is not updated, so the system retries on the next run instead of silently dropping commits.
Docs
- Expanded troubleshooting guide for "Josh rejected push" with root cause analysis and prevention advice.
- Added ADR-011: Linearize fallback for reverse sync.
- Added recommended Git workflow section to the guide.
1.2.0
Breaking Changes
None.
Features
- File exclusion:
excludeconfig field removes files/directories from the subrepo at the josh-proxy transport layer. Patterns are embedded inline in the josh-proxy URL using:exclude[::pattern,...]syntax — no extra files to generate or commit. - Filter change reconciliation: When the josh filter changes (e.g., adding/removing exclude patterns), josh-sync automatically creates a reconciliation merge commit that connects old and new histories. No manual reset or force-push required.
- Tree comparison guard: Reverse sync now compares subrepo tree to josh-filtered tree before checking commit log. Skips immediately when trees are identical, avoiding false positives from reconciliation merge history.
- Unrelated histories detection: Forward sync detects when histories are unrelated (no common ancestor) and falls back to reconciliation instead of creating a useless conflict PR.
Fixes
- Pre-v1.2 state compatibility: When upgrading from v1.0/v1.1 (no
josh_filterstored in state), the old filter is derived fromsubfolderso reconciliation triggers correctly. - Reconciliation merge parent order: Josh-filtered history is always first parent so josh-proxy can follow first-parent traversal back to the monorepo.
- Reverse sync
--ancestry-pathflag prevents old subrepo history from leaking through reconciliation merge parents. - PR body
\nnow renders as actual newlines instead of literal text. - Conflict result no longer updates sync state (added
continueto skip state write). action.ymlnow copies VERSION file for correct--versionoutput in CI..gitignorenow includesdist/and.env.
1.1.0
Breaking Changes
None.
Features
onboardcommand: Interactive, resumable workflow for importing existing subrepos into the monorepo. Walks through: prerequisites check, import (creates PRs), wait for merge, reset (pushes josh-filtered history). Checkpoint/resume at every step.migrate-prcommand: Migrates open PRs from an archived subrepo to the new one. Supports interactive selection,--allflag, and specific PR numbers. Usesgit apply --3wayfor resilient patch application.- Onboard state tracking: Stored on the
josh-sync-statebranch at<target>/onboard.json. Tracks step progress, import PR numbers, reset branches, and migrated PRs.
1.0.0
Initial release. Extracted from private-monorepo-example into a standalone reusable library.
Features
- Bidirectional sync: forward (mono → subrepo) and reverse (subrepo → mono)
- Multi-target support via
.josh-sync.ymlconfig - Per-target credential overrides (SSH keys, HTTPS tokens)
- Force-with-lease safety for forward sync
- Loop prevention via git trailers
- State tracking on orphan branch (
josh-sync-state) - Initial import and subrepo reset commands
- Composite action for Gitea/GitHub CI
- Nix flake with devenv module
- Preflight validation checks
- Config schema (JSON Schema)
Breaking Changes (vs. inline scripts)
- Python + pyyaml replaced by yq-go (single static binary)
- 7 separate scripts replaced by single
josh-syncCLI - Consumer workflows use composite action (
uses: https://your-gitea/org/josh-sync@v1)