Skip to content

feat(job): show post-import notes from item README on import-set - #619

Open
clavery wants to merge 4 commits into
mainfrom
feature/import-set-updates
Open

feat(job): show post-import notes from item README on import-set#619
clavery wants to merge 4 commits into
mainfrom
feature/import-set-updates

Conversation

@clavery

@clavery clavery commented Aug 13, 2026

Copy link
Copy Markdown
Collaborator

Summary

Adds post-import notes to b2c job import-set. Many site-import migrations require manual, instance-specific follow-up that cannot live in a site archive — enabling a site preference, wiring a service credential in Business Manager, flipping a feature toggle. This lets each migration document that follow-up in a README.md (or README) at the top of the item's directory, and surfaces it in a consolidated summary after the run.

Also adds a dedicated, opt-in b2c-cli:b2c-import-set-migrations skill for the full migration workflow.

Behavior

  • Each item directory may contain a README.md (preferred) or README; its trimmed contents become the item's note. Zip items and the set's top-level README are not treated as item notes.
  • After a run, notes print only for items applied in this run — already-applied (skipped) items don't re-announce their notes, so the summary reflects only what just changed.
  • --dry-run previews notes for pending items so operators can review manual steps before importing.
  • With --json, nothing extra prints; each item's note is available on the item in the JSON result.

Example output:

Import set complete: 1 imported, 3 skipped

Post-import notes:

  20260801T140000-add-preferences
    # Add feature-X preferences
    Set the Feature X API endpoint in Business Manager (differs per environment).

Changes

  • SDK (operations/jobs/import-set.ts): adds note? to ImportSetItem, read during discoverImportSet (README.md > README, empty → undefined, directories only). Flows into results via the existing spread.
  • CLI (commands/job/import-set.ts): adds logNotes(), called after the summary line in non-JSON mode.
  • New skill b2c-cli:b2c-import-set-migrations: dedicated migration workflow guide (layout, UTC naming, post-import notes, receipts/idempotency, set IDs, locking, CI/CD, recovery). Framed as an optional, opt-in, project-level approach — the agent follows it where a project has adopted it and may propose it where the goal fits, but does not silently restructure one-off imports into import sets. Cross-linked from the b2c-job and b2c-site-import-export skills, and ships with evals/trigger-evals.json.
  • Docs: new "Post-import notes" section in docs/cli/jobs.md.
  • Tests added for SDK discovery/precedence/result-carrying and CLI rendering (run + dry-run).

Read a README.md/README at the top of each import-set item directory and
print its contents in a consolidated post-import notes summary after a run
(previewed for pending items during --dry-run). This is the idiomatic place
to document manual, instance-specific follow-up for a migration.

Also adds a dedicated b2c-import-set-migrations skill covering the full
migration workflow.
@clavery
clavery deployed to b2c-docs-preview August 13, 2026 03:38 — with GitHub Actions Active
@github-actions

Copy link
Copy Markdown
Contributor

📘 Docs preview

Your documentation changes are published at:

https://d3uhw92m2zac57.cloudfront.net/pr-619/

Commit 702798b · ✅ Published

This preview updates on every push and is removed when the PR is closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant