Add MIGRATING.md and protect from regen overwrite#110
Closed
highb wants to merge 1 commit into
Closed
Conversation
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.
Contributor
Author
|
irrelevant, these migrations no longer need to happen |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Why
Cutting v2.0.0-alpha.1 (see #109) introduces breaking changes that customers need clear guidance on:
Layout
`MIGRATING.md` follows the convention used by aws-sdk-go-v2, gorm, and similar Go SDKs that have crossed major versions. Sections:
Follow-ups
🤖 Generated with Claude Code