--- name: vpk-sync description: >- This skill should be used when the user asks to "sync with VPK", "pull updates", "push changes", "contribute back", "pull orphan branch", "update from VPK", "get latest VPK", "contribute feature branch", or wants to keep their prototype in sync with upstream VPK. argument-hint: "[--pull] [--push] [--contribute] [--pull-orphan] [--init] [--status]" --- # VPK Sync > Synchronize changes between your VPK prototype and the upstream VPK prototype kit. > Works with or without creating a separate GitHub repo for your prototype. --- ## Quick Start ```bash \/vpk-sync # Interactive mode - choose pull, push, merge, or configure \/vpk-sync --status # Show sync status (commits ahead\/behind) \/vpk-sync --pull # Pull latest updates from upstream VPK \/vpk-sync --push # Push local changes back to upstream via PR \/vpk-sync --contribute # Contribute feature branches back to upstream (interactive) \/vpk-sync --pull-orphan # Pull an orphan branch into main \/vpk-sync --init # Configure upstream repository connection ``` ### Shorthand Aliases | Alias | Equivalent | Description | | ------------------- | -------------- | --------------------------- | | `\/vpk-sync` | Interactive | Choose action from menu | | `\/vpk-sync up` | `--push` | Push changes to upstream | | `\/vpk-sync down` | `--pull` | Pull updates from upstream | | `\/vpk-sync contrib` | `--contribute` | Contribute feature branches | --- ## Prerequisites - **Git** installed and configured - **GitHub CLI** (`gh`) authenticated (`gh auth status`) - **Upstream access** - read access for pull, write or fork for push --- ## Workflow Scenarios ### Scenario A: Cloned VPK, No Separate Repo If you cloned VPK and are working directly in it (without `\/vpk-share --create`): 1. **Configure upstream** (one time): `\/vpk-sync --init` - This renames `origin` → `upstream` and configures sync 2. **Pull updates**: `\/vpk-sync --pull` 3. **Push improvements**: `\/vpk-sync --push` (creates PR via fork) ### Scenario B: Created Separate Repo via `\/vpk-share` If you used `\/vpk-share --create my-project`: 1. **Upstream already configured** (automatic) - `origin` = your new repo - `upstream` = VPK 2. **Pull updates**: `\/vpk-sync --pull` 3. **Push improvements**: `\/vpk-sync --push` --- ## Status Workflow (`--status`) Shows current sync status with upstream. ### Agent Instructions for Status 1. **Check if upstream is configured** ```bash git remote get-url upstream 2>\/dev\/null ``` If missing, suggest `\/vpk-sync --init` 2. **Fetch and compare** ```bash git fetch upstream BEHIND=$(git rev-list --count HEAD..upstream\/main 2>\/dev\/null || echo "0") AHEAD=$(git rev-list --count upstream\/main..HEAD 2>\/dev\/null || echo "0") ``` 3. **Report status** - `X commits behind` - can pull updates - `X commits ahead` - can push improvements - `Up to date` - fully synced --- ## Interactive Workflow (Default) When invoked without flags, use `AskUserQuestion` to determine user intent: ```yaml header: "Sync direction" question: "What would you like to do?" options: - label: "Check status" description: "See how many commits ahead\/behind upstream" - label: "Pull updates" description: "Get latest changes from upstream VPK" - label: "Push changes" description: "Contribute current branch changes to upstream" - label: "Contribute feature branch" description: "Select a feature branch and commits to contribute" - label: "Pull orphan branch" description: "Pull a branch with different commit history into main" - label: "Configure" description: "Set up or change upstream connection" ``` --- ## Pull Workflow (`--pull`) ### What Gets Synced All files from upstream **except**: - Credentials: `.env*`, `.asap-config`, `*.pem`, `*.key` - Deployment: `.deploy.local`, `service-descriptor.yml` - Personal config: `*.local.md`, `*.local.json`, `.vpk-sync.json` - Build artifacts: `node_modules\/`, `.next\/`, `out\/` ### Strategy Options | Strategy | When to Use | Command | | ------------------- | ----------------------------------- | ------------------------------------ | | **Merge** (default) | Safer, preserves history | `--pull` | | **Rebase** | Cleaner history, more advanced | `--pull --rebase` | | **Allow unrelated** | Legacy repos without shared history | `--pull --allow-unrelated-histories` | ### Conflict Handling If conflicts occur: 1. Script identifies conflicting files 2. Provides resolution guidance 3. User resolves manually 4. User runs `git add ` then `git merge --continue` (or `git rebase --continue`) ### Agent Instructions for Pull 1. **Check for uncommitted changes** ```bash git status --porcelain ``` If changes exist, ask user: stash, commit, or abort? 2. **Verify upstream remote exists** ```bash git remote get-url upstream 2>\/dev\/null ``` If missing, run init workflow first. 3. **Fetch upstream** ```bash git fetch upstream ``` 4. **Execute sync** ```bash .\/.cursor\/skills\/vpk-sync\/scripts\/sync-pull.sh [--rebase] [--allow-unrelated-histories] [--dry-run] ``` 5. **Report results** - summarize what was updated or any conflicts 6. **If "unrelated histories" error occurs** - suggest re-running with `--allow-unrelated-histories` --- ## Push Workflow (`--push`) ### What Gets Pushed By default, all tracked changes. Use `--paths` to limit: ```bash \/vpk-sync --push --paths "components\/blocks\/new-feature\/" ``` ### Files Never Pushed Same exclusions as pull (credentials, deployment config, personal settings). ### Agent Instructions for Push 1. **Check for changes to push** ```bash git status --porcelain git log upstream\/main..HEAD --oneline 2>\/dev\/null ``` 2. **Verify GitHub CLI is authenticated** ```bash gh auth status ``` 3. **Gather PR details via AskUserQuestion** ```yaml header: "PR details" questions: - prompt: "What does this change do?" description: "Used for PR title and description" - prompt: "Which files should be included?" description: "Leave blank for all changes, or specify paths" ``` 4. **Execute push** ```bash .\/.cursor\/skills\/vpk-sync\/scripts\/sync-push.sh --title "Title" [--paths "..."] [--dry-run] ``` 5. **Report PR URL** - provide link for user to review --- ## Contribute Workflow (`--contribute`) ### When to Use Use this when you've developed features on **separate branches** and want to contribute specific branches or commits back to upstream VPK. This is different from `--push` which pushes commits from main. **Key scenarios:** - You developed a sidebar collapse feature on `feature\/sidebar-collapse` - You merged it to your project's main branch - Now you want to contribute that feature (or specific commits from it) to upstream VPK - You may want to exclude project-specific commits (e.g., brand colors, custom modals) ### How It Works 1. **Track with git tags** — Contributed commits are marked with `vpk-contributed\/` tags 2. **Cherry-pick approach** — Selected commits are cherry-picked onto a clean branch from upstream\/main 3. **Partial contributions** — The same branch can be contributed multiple times with different commits 4. **Status visibility** — `--list` shows which branches have pending vs. contributed commits ### Command Options ```bash \/vpk-sync --contribute # Interactive: list branches, select commits \/vpk-sync --contribute --list # List branches with contribution status \/vpk-sync --contribute # Contribute specific branch \/vpk-sync --contribute --all # Include all commits \/vpk-sync --contribute --commits "1,2,4" # Include specific commits \/vpk-sync --contribute --exclude "3,5" # Exclude specific commits \/vpk-sync --contribute --dry-run # Preview without making changes ``` ### Agent Instructions for Contribute 1. **List available branches** ```bash .\/.cursor\/skills\/vpk-sync\/scripts\/sync-contribute.sh --list ``` This shows: - Feature branches with commits ahead of upstream\/main - Number of commits on each branch - Contribution status (not contributed \/ partially contributed \/ fully contributed) 2. **Interactive branch selection** (if no branch specified) Use `AskUserQuestion` to present branches: ```yaml header: "Select branch" question: "Which branch would you like to contribute?" options: # Dynamically populated from --list output - label: "feature\/sidebar-collapse" description: "5 commits ahead, not contributed" - label: "feature\/new-widget" description: "3 commits ahead, 1\/3 contributed" ``` 3. **Show commits for selected branch** ```bash .\/.cursor\/skills\/vpk-sync\/scripts\/sync-contribute.sh ``` This displays commits with their contribution status: ``` Commits on feature\/sidebar-collapse: 1. abc1234 - Add collapse hook [pending] 2. def5678 - Add animation [pending] 3. 111aaaa - Fix z-index for our modal [pending] 4. ghi9012 - Add localStorage [contributed] ``` 4. **Allow commit selection via AskUserQuestion** ```yaml header: "Commit selection" question: "Enter commit numbers to EXCLUDE (or leave blank for all pending)" multiSelect: false options: - label: "Include all pending" description: "Contribute commits 1, 2, 3 (excludes already contributed)" - label: "Exclude some" description: "I'll specify which to exclude" ``` If user chooses to exclude, ask for comma-separated numbers. 5. **Execute contribution** ```bash .\/.cursor\/skills\/vpk-sync\/scripts\/sync-contribute.sh --exclude "3,5" # or .\/.cursor\/skills\/vpk-sync\/scripts\/sync-contribute.sh --commits "1,2,4" # or .\/.cursor\/skills\/vpk-sync\/scripts\/sync-contribute.sh --all ``` 6. **Report PR URL** - provide link for user to review ### Conflict Resolution When a cherry-pick conflict occurs: 1. Script pauses and shows conflicting files 2. User resolves conflicts manually 3. User runs: ```bash git add git cherry-pick --continue ``` 4. Then completes the contribution: ```bash git push -u origin vpk-contribute\/- gh pr create --repo --base main --title "..." ``` To abort instead: ```bash git cherry-pick --abort git checkout git branch -D vpk-contribute\/- ``` ### Tracking Mechanism Contributed commits are tracked via git tags: ```bash # Tag format vpk-contributed\/ # Tag message format "PR #123 on 2026-01-31 from feature\/sidebar-collapse" # Query all contributed commits git tag -l "vpk-contributed\/*" # Check if specific commit was contributed git tag -l "vpk-contributed\/abc1234" # View tag details git tag -l -n1 "vpk-contributed\/abc1234" ``` This allows: - Same branch to be contributed multiple times - Individual commit tracking independent of branches - PR history visible in tag messages --- ## Pull Orphan Workflow (`--pull-orphan`) ### When to Use Use this when a branch has **no common commit history** with main. This happens when: - A branch was created from a fresh VPK boilerplate export - A branch was force-pushed with different base commits - GitHub shows "entirely different commit histories" error ### How It Works 1. Identifies the orphan branch and its commits 2. Cherry-picks commits onto a new branch based on main 3. Creates a PR from the rebased branch 4. Optionally merges the PR ### Agent Instructions for Pull Orphan 1. **List open PRs or branches** ```bash gh pr list --state open --json number,title,headRefName,url git fetch origin git branch -r | grep -v main ``` 2. **Ask user which branch to pull** (if multiple) ```yaml header: "Select branch" question: "Which branch would you like to pull?" options: # Dynamically populated from git branch -r output - label: "" description: "PR #X: " - label: "" description: "PR #Y: " ``` 3. **Check if branch has common history with main** ```bash git merge-base --is-ancestor origin\/main origin\/ 2>\/dev\/null # Exit code 0 = has common history (use normal merge) # Exit code 1 = no common history (needs cherry-pick) ``` 4. **If no common history, cherry-pick approach:** ```bash # Get commits unique to the orphan branch git log origin\/ --oneline # Create new branch from main git checkout main git checkout -b -rebased # Cherry-pick each commit (skip the boilerplate base if any) git cherry-pick # Resolve conflicts if any # For each conflict: review, resolve, git add, git cherry-pick --continue ``` 5. **Push and create PR** ```bash git push -u origin -rebased gh pr create --base main --head -rebased --title "..." --body "..." ``` 6. **Optionally merge the PR** ```bash gh pr merge --merge ``` 7. **Clean up** (optional) ```bash git checkout main git pull origin main git branch -d -rebased ``` ### Conflict Resolution During Cherry-Pick When conflicts occur: 1. Check which files conflict: `git diff --name-only --diff-filter=U` 2. Open and resolve conflicts manually 3. Stage resolved files: `git add ` 4. Continue: `git cherry-pick --continue` If a commit is entirely superseded by main, skip it: ```bash git cherry-pick --skip ``` --- ## Init Workflow (`--init`) ### When to Use - First time setting up sync (if not using `\/vpk-share --create`) - Changing upstream repository - Reconfiguring sync preferences ### Agent Instructions for Init 1. **Check current configuration** ```bash git remote get-url upstream 2>\/dev\/null git remote get-url origin 2>\/dev\/null cat .vpk-sync.json 2>\/dev\/null ``` 2. **Determine scenario** - If `origin` points to VPK and no `upstream`: rename origin → upstream - If `origin` points to user's repo and no `upstream`: add upstream 3. **Ask for upstream URL** (if not already configured) Default: `https:\/\/github.com\/eevennsoh\/VPK` 4. **Execute init** ```bash .\/.cursor\/skills\/vpk-sync\/scripts\/sync-init.sh [--strategy merge|rebase] ``` 5. **Verify connection** ```bash git fetch upstream --dry-run ``` --- ## References For detailed documentation, see: - [`references\/configuration.md`](references\/configuration.md) - `.vpk-sync.json` format and options - [`references\/scripts.md`](references\/scripts.md) - Script usage and examples --- ## Troubleshooting ### "No upstream remote configured" Run init first: ```bash \/vpk-sync --init ``` ### "Uncommitted changes detected" Options: 1. Stash: `git stash` → sync → `git stash pop` 2. Commit: `git add . && git commit -m "WIP"` 3. Discard: `git checkout .` (loses changes) ### "Merge conflicts" 1. Open conflicting files (marked with `<<<<<<<`) 2. Resolve conflicts manually 3. Stage resolved files: `git add ` 4. Continue: `git merge --continue` or `git rebase --continue` ### "Permission denied on push" Options: 1. Use fork: `\/vpk-sync --push --use-fork` 2. Request write access to upstream 3. Create fork manually and update config ### "gh CLI not authenticated" ```bash gh auth login ``` ### "Entirely different commit histories" or "refusing to merge unrelated histories" This happens when your repo was created before `\/vpk-share --create` was updated to preserve commit history. **For pulling updates (most common):** ```bash # Re-run with --allow-unrelated-histories \/vpk-sync --pull --allow-unrelated-histories ``` **For pulling orphan branches:** ```bash # Use the pull-orphan workflow \/vpk-sync --pull-orphan # Or manually: git checkout main git checkout -b -rebased git cherry-pick # Skip the boilerplate commit git push -u origin -rebased gh pr create --base main --head -rebased ``` **Note:** New projects created with `\/vpk-share --create` now preserve VPK's commit history, so this won't be needed for future projects. --- ## Examples ### Initial Setup ```bash # Configure upstream connection \/vpk-sync --init # Or with specific URL \/vpk-sync --init https:\/\/github.com\/your-org\/vpk-fork ``` ### Check Sync Status ```bash # See how many commits ahead\/behind \/vpk-sync --status # Output example: # Upstream: https:\/\/github.com\/eevennsoh\/VPK # Status: 3 commits behind, 2 commits ahead ``` ### Get Latest Updates ```bash # Standard merge \/vpk-sync --pull # Preview what would change \/vpk-sync --pull --dry-run # Use rebase for cleaner history \/vpk-sync --pull --rebase # For legacy repos without shared history \/vpk-sync --pull --allow-unrelated-histories ``` ### Contribute Back ```bash # Push all changes \/vpk-sync --push # Push specific feature \/vpk-sync --push --paths "components\/blocks\/my-feature\/" # Preview PR \/vpk-sync --push --dry-run ``` ### Pull Orphan Branch ```bash # Pull a branch with no common history \/vpk-sync --pull-orphan # Pull specific branch \/vpk-sync --pull-orphan fix-composer # Useful when GitHub shows: # "main and are entirely different commit histories" ``` ### Contribute Feature Branch ```bash # List branches available for contribution \/vpk-sync --contribute --list # Interactive mode: select branch and commits \/vpk-sync --contribute # Contribute specific branch (all pending commits) \/vpk-sync --contribute feature\/sidebar-collapse # Contribute all commits including already contributed ones \/vpk-sync --contribute feature\/sidebar-collapse --all # Include only specific commits (by number from list) \/vpk-sync --contribute feature\/sidebar-collapse --commits "1,2,4" # Exclude specific commits (project-specific customizations) \/vpk-sync --contribute feature\/sidebar-collapse --exclude "3,5" # Preview without making changes \/vpk-sync --contribute feature\/sidebar-collapse --dry-run ``` ### Query Contribution History ```bash # List all contributed commits git tag -l "vpk-contributed\/*" # Check if specific commit was contributed git tag -l "vpk-contributed\/abc1234" # View contribution details (includes PR number and source branch) git tag -l -n1 "vpk-contributed\/abc1234" ``` --- ## Integration with Other Skills | Skill | Relationship | | --------------------- | ---------------------------------------------- | | `\/vpk-setup` | Run first to configure credentials | | `\/vpk-share --create` | Creates new repo with upstream auto-configured | | `\/vpk-deploy` | Deploy after pulling updates | ### Typical Workflow ``` 1. Clone VPK 2. \/vpk-setup (credentials) 3. \/vpk-share --create my-project (optional - creates separate repo) 4. Develop... 5. \/vpk-sync --push (contribute back) 6. \/vpk-sync --pull (get updates periodically) ```