-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
docs(sdk): migrate feature-branches to playbooks format #16497
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
stephanie-anderson
merged 2 commits into
master
from
sanderson/migrate-feature-branches-playbook
Feb 23, 2026
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
76 changes: 76 additions & 0 deletions
76
develop-docs/sdk/getting-started/playbooks/syncing-feature-branches.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| --- | ||
| title: Syncing Feature Branches | ||
| spec_id: sdk/playbooks/syncing-feature-branches | ||
| spec_version: 1.0.0 | ||
| spec_status: candidate | ||
| spec_changelog: | ||
| - version: 1.0.0 | ||
| date: 2026-02-21 | ||
| summary: Initial playbook — migrated from sdk/miscellaneous/feature-branches | ||
| --- | ||
|
|
||
| <SpecRfcAlert /> | ||
|
|
||
| <SpecMeta /> | ||
|
|
||
| ## Overview | ||
|
|
||
| Sometimes we have long-running feature branches that can't be merged into `master` yet because they contain breaking changes (e.g. `sentry-sdk-2.0`, `potel-base` in python SDK, `8.x.x` in Java SDK). They have to be kept in sync with `master`/`main`. | ||
|
|
||
| You might be tempted to branch off the feature branch and do the merge there, maybe make a PR so that you can double-check the changes in the UI and make sure CI is green. In that case you need to make sure you **don't actually commit the merge from another branch** — the merge commit needs to be directly on the feature branch, otherwise `git` doesn't set the parent commits for the merge commit properly and the feature branch will still have unresolved conflicts. | ||
|
|
||
| --- | ||
|
|
||
| ## Steps | ||
|
|
||
| #### 1. Merge main into the feature branch | ||
|
|
||
| You **MUST** perform the merge directly on the feature branch so that git records the correct parent commits: | ||
|
|
||
| ```bash | ||
| git checkout feature-branch | ||
| git merge master | ||
| ``` | ||
|
|
||
| #### 2. Resolve conflicts | ||
|
|
||
| Resolve all conflicts while still on the feature branch and commit the merge. | ||
|
|
||
| #### 3. Verify (optional) | ||
|
|
||
| If you want a GitHub diff and CI run before pushing: | ||
|
|
||
| - Open a new branch from the feature branch: `git checkout -b sync-feature-with-master` | ||
| - Push and create a PR to review the diff and CI results | ||
| - **Do NOT merge the PR** — merging from the temporary branch will not mark the merge conflicts as resolved on the feature branch | ||
|
|
||
| #### 4. Push the feature branch | ||
|
|
||
| Once satisfied, push directly from the feature branch: | ||
|
|
||
| ```bash | ||
| git checkout feature-branch | ||
| git push | ||
| ``` | ||
|
|
||
| ## Alternative Approaches | ||
|
|
||
| #### Alternative A — merge PR then empty merge (used for Java SDK `8.x.x`) | ||
|
|
||
| Note: this approach does not preserve full per-file history — history only works on the full repo. | ||
|
|
||
| 1. Create a PR for merging `main` into the feature branch (e.g. `8.x.x`) | ||
| 2. Once that PR is merged, the reverse PR (feature branch back to `main`) will still show conflicts | ||
| 3. Do another merge of `main` into the feature branch where you accept all changes on the feature branch side and create an empty merge commit | ||
| 4. **Caveat:** if there are new commits on `main` between steps, this won't work correctly | ||
|
|
||
| #### Alternative B — merge commit PR (untested) | ||
|
|
||
| 1. Create a merge PR for merging `main` into the feature branch | ||
| 2. When merging the PR, do not squash — create a merge commit (may need to enable this in repo settings) | ||
|
|
||
| --- | ||
|
|
||
| ## Changelog | ||
|
|
||
| <SpecChangelog /> |
This file was deleted.
Oops, something went wrong.
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Redirect change breaks sub-path chain resolution
Low Severity
The
/sdk/development-process/:path*redirect destination changed from/sdk/processes/:path*(path-preserving) to/sdk/getting-started/(catch-all). This breaks redirect chains for sub-paths like/sdk/development-process/releases/, which previously chained through/sdk/processes/releases/to reach the specific playbook page at/sdk/getting-started/playbooks/setting-up-release-infrastructure/. Now all sub-paths land on the generic/sdk/getting-started/page instead.Additional Locations (1)
redirects.js#L192-L194