Skip to content

Add MIGRATING.md and protect from regen overwrite#110

Closed
highb wants to merge 1 commit into
mainfrom
highb/iga-1181-migration-docs
Closed

Add MIGRATING.md and protect from regen overwrite#110
highb wants to merge 1 commit into
mainfrom
highb/iga-1181-migration-docs

Conversation

@highb
Copy link
Copy Markdown
Contributor

@highb highb commented Apr 30, 2026

Summary

  • New `MIGRATING.md` at repo root: hand-written v1 → v2 upgrade guide
  • `.genignore` entries for `MIGRATING.md` and `CHANGELOG.md` so Speakeasy never overwrites hand-written guides on regen

Why

Cutting v2.0.0-alpha.1 (see #109) introduces breaking changes that customers need clear guidance on:

  1. Module path break (the biggest one): `import "github.com/conductorone/conductorone-sdk-go"` → `.../v2`. Required by Go's semantic import versioning for any v2.0.0+ release.
  2. IGA-1181 schema renames: `AccessConflictNotificationConfig`, `AutomationsTaskAction`, `PolicyForm`, `AppOwnersV2` / `AppEntitlementOwnersV2` service splits.
  3. New API surfaces added since v1.27.x: paper-secret, role-mining, principal/credentials, workload-federation, A2UI surfaces, automations expansion.

Layout

`MIGRATING.md` follows the convention used by aws-sdk-go-v2, gorm, and similar Go SDKs that have crossed major versions. Sections:

  1. Module path break — concrete `go get` + sed-replace recipe
  2. Renamed types — service splits and schema renames (some placeholders to fill in once Migrate to /v2 module path; pre-stage 2.0.0-alpha.1 bump #109's regen PR posts the full breaking-change list)
  3. New services and fields (additive, opt-in)
  4. Workflow / CI guidance for Dependabot/Renovate users
  5. Issue reporting

Follow-ups

  • Once PR #109's regen PR opens, populate the field-level breaking changes section with the actual `Breaking ⚠️` list from that PR's body
  • Tag `v2.0.0-alpha.1` after regen merges (existing `speakeasy_sdk_publish.yml` workflow auto-tags on RELEASES.md push)

🤖 Generated with Claude Code

In preparation for the v2.0.0-alpha.1 cut (PR #109), add the
user-facing migration documentation:

- **MIGRATING.md** — hand-written v1 → v2 upgrade guide covering the
  module path break (the biggest one — `import .../conductorone-sdk-go`
  → `.../v2`), the IGA-1181 schema renames (AccessConflictNotificationConfig,
  AutomationsTaskAction, PolicyForm, V2 service splits), and the new
  API surfaces accumulated since v1.27.x (paper-secret, role-mining,
  principal, workload-federation, A2UI). Some sections are placeholders
  to be populated when the v2.0.0-alpha.1 regen PR's full breaking-change
  list is available.

- **.genignore** entries for `MIGRATING.md` and `CHANGELOG.md` so
  Speakeasy never overwrites the hand-written guides on regen.
@linear
Copy link
Copy Markdown

linear Bot commented Apr 30, 2026

@highb
Copy link
Copy Markdown
Contributor Author

highb commented May 5, 2026

irrelevant, these migrations no longer need to happen

@highb highb closed this May 5, 2026
@highb highb deleted the highb/iga-1181-migration-docs branch May 5, 2026 20:36
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.

1 participant