Skip to content

Commit 1a7624e

Browse files
authored
Merge branch 'main' into rz/fix/anr-gesture-detector
2 parents 7aa100c + 092f017 commit 1a7624e

File tree

202 files changed

+5678
-1496
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

202 files changed

+5678
-1496
lines changed

.claude/skills/create-java-pr/SKILL.md

Lines changed: 62 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,24 @@
11
---
22
name: create-java-pr
3-
description: Create a pull request in sentry-java. Use when asked to "create pr", "prepare pr", "prep pr", "open pr", "ready for pr", "prepare for review", "finalize changes". Handles branch creation, code formatting, API dump, committing, pushing, PR creation, and changelog.
3+
description: Create a pull request in sentry-java. Use when asked to "create pr", "prepare pr", "prep pr", "open pr", "ready for pr", "prepare for review", "finalize changes". Handles branch creation, code formatting, API dump, committing, pushing, PR creation, changelog, and stacked PRs.
44
---
55

66
# Create Pull Request (sentry-java)
77

88
Prepare local changes and create a pull request for the sentry-java repo.
99

10+
**Required reading:** Before proceeding, read `.cursor/rules/pr.mdc` for the full PR and stacked PR workflow details. That file is the source of truth for PR conventions, stack comment format, branch naming, and merge strategy.
11+
12+
## Step 0: Determine PR Type
13+
14+
Ask the user (or infer from context) whether this is:
15+
16+
- **Standalone PR** — a regular PR targeting `main`. Follow Steps 1–6 as written.
17+
- **First PR of a new stack** — ask for a topic name (e.g. "Global Attributes"). Create a collection branch from `main`, then branch the first PR off it. The first PR targets the collection branch.
18+
- **Next PR in an existing stack** — identify the previous stack branch and topic. This PR targets the previous stack branch.
19+
20+
If the user mentions "stack", "stacked PR", or provides a topic name with a number (e.g. `[Topic 2]`), treat it as a stacked PR. See `.cursor/rules/pr.mdc` § "Stacked PRs" for full details.
21+
1022
## Step 1: Ensure Feature Branch
1123

1224
```bash
@@ -21,6 +33,10 @@ git checkout -b <type>/<short-description>
2133

2234
Derive the branch name from the changes being made. Use `feat/`, `fix/`, `ref/`, etc. matching the commit type conventions.
2335

36+
**For stacked PRs:** For the first PR in a new stack, first create and push the collection branch (see `.cursor/rules/pr.mdc` § "Creating the Collection Branch"), then branch the PR off it. For subsequent PRs, branch off the previous stack branch. Use the naming conventions from `.cursor/rules/pr.mdc` § "Branch Naming".
37+
38+
**CRITICAL: Never merge, fast-forward, or push commits into the collection branch.** It stays at its initial position until the user merges stack PRs through GitHub. Updating it will auto-merge and destroy the entire PR stack.
39+
2440
## Step 2: Format Code and Regenerate API Files
2541

2642
```bash
@@ -92,13 +108,45 @@ Invoke the `sentry-skills:create-pr` skill to create a draft PR. When providing
92108

93109
Fill in each section based on the changes being PR'd. Check any checklist items that apply.
94110

95-
Then continue to Step 6.
111+
**For stacked PRs:**
112+
113+
- Pass `--base <previous-stack-branch>` so the PR targets the previous branch (first PR in a stack targets the collection branch).
114+
- Use the stacked PR title format: `<type>(<scope>): [<Topic> <N>] <Subject>` (see `.cursor/rules/pr.mdc` § "PR Title Naming").
115+
- Include the stack list at the top of the PR body, before the `## :scroll: Description` section (see `.cursor/rules/pr.mdc` § "Stack List in PR Description" for the format).
116+
- Add a merge method reminder at the very end of the PR body (see `.cursor/rules/pr.mdc` § "Stack List in PR Description" for the exact text). This only applies to stack PRs, not the collection branch PR.
117+
118+
Then continue to Step 5.5 (stacked PRs only) or Step 6.
119+
120+
## Step 5.5: Update Stack List on All PRs (stacked PRs only)
121+
122+
Skip this step for standalone PRs.
123+
124+
After creating the PR, update the PR description on **every other PR in the stack — including the collection branch PR** — so all PRs have the same up-to-date stack list. Follow the format and commands in `.cursor/rules/pr.mdc` § "Stack List in PR Description".
125+
126+
**Important:** When updating PR bodies, never use shell redirects (`>`, `>>`) or pipes (`|`) or compound commands (`&&`). These create compound shell expressions that won't match permission patterns. Instead:
127+
- Use `gh pr view <NUMBER> --json body --jq '.body'` to get the body (output returned directly)
128+
- Use the `Write` tool to save it to a temp file
129+
- Use the `Edit` tool to modify the temp file
130+
- Use `gh pr edit <NUMBER> --body-file /tmp/pr-body.md` to update
96131

97132
## Step 6: Update Changelog
98133

99-
After the PR is created, add an entry to `CHANGELOG.md` under the `## Unreleased` section.
134+
First, determine whether a changelog entry is needed. **Skip this step** (and go straight to "No changelog needed" below) if the changes are not user-facing, for example:
135+
136+
- Test-only changes (new tests, test refactors, test fixtures)
137+
- CI/CD or build configuration changes
138+
- Documentation-only changes
139+
- Code comments or formatting-only changes
140+
- Internal refactors with no behavior change visible to SDK users
141+
- Sample app changes
142+
143+
If unsure, ask the user.
100144

101-
### Determine the subsection
145+
### If changelog is needed
146+
147+
Add an entry to `CHANGELOG.md` under the `## Unreleased` section.
148+
149+
#### Determine the subsection
102150

103151
| Change Type | Subsection |
104152
|---|---|
@@ -109,15 +157,15 @@ After the PR is created, add an entry to `CHANGELOG.md` under the `## Unreleased
109157

110158
Create the subsection under `## Unreleased` if it does not already exist.
111159

112-
### Entry format
160+
#### Entry format
113161

114162
```markdown
115163
- <Short description of the change> ([#<PR_NUMBER>](https://github.com/getsentry/sentry-java/pull/<PR_NUMBER>))
116164
```
117165

118166
Use the PR number returned by `sentry-skills:create-pr`. Match the style of existing entries — sentence case, ending with the PR link, no trailing period.
119167

120-
### Commit and push
168+
#### Commit and push
121169

122170
Stage `CHANGELOG.md`, commit with message `changelog`, and push:
123171

@@ -126,3 +174,11 @@ git add CHANGELOG.md
126174
git commit -m "changelog"
127175
git push
128176
```
177+
178+
### No changelog needed
179+
180+
If no changelog entry is needed, add `#skip-changelog` to the PR description to disable the changelog CI check:
181+
182+
1. Get the current body: `gh pr view <PR_NUMBER> --json body --jq '.body'`
183+
2. Use the `Write` tool to save the output to `/tmp/pr-body.md`, appending `\n#skip-changelog\n` at the end
184+
3. Update: `gh pr edit <PR_NUMBER> --body-file /tmp/pr-body.md`

.cursor/rules/pr.mdc

Lines changed: 60 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -120,21 +120,25 @@ Stacked PRs split a large feature into small, easy-to-review PRs where each buil
120120
### Structure
121121

122122
```
123-
main stack-pr-1 stack-pr-2 stack-pr-3 ...
123+
main ← collection-branch ← stack-pr-1 stack-pr-2 stack-pr-3 ...
124124
```
125125

126-
- The first PR in the stack targets `main` as its base branch.
126+
- A **collection branch** is created from `main` and targets `main`. It serves as the base for the entire stack.
127+
- The first PR in the stack targets the collection branch (not `main`).
127128
- Each subsequent PR targets the previous stack PR's branch as its base.
128129
- Each PR contains only incremental changes on top of the previous one.
129130

131+
The collection branch exists so that individual stack PRs can be **merge-committed** (not squashed). PRs targeting `main` use squash merging, but that causes repeated merge conflicts when syncing the stack. Merge commits on non-`main` branches avoid this. The collection branch itself is squash-merged into `main` at the end.
132+
130133
### Branch Naming
131134

132-
Prefer a shared prefix for the feature, with descriptive suffixes per PR. The type prefix (`feat/`, `fix/`, etc.) may vary depending on the nature of each PR's changes:
135+
Prefer a shared prefix for the feature, with descriptive suffixes per PR. The collection branch uses the shared prefix. The type prefix (`feat/`, `fix/`, etc.) may vary depending on the nature of each PR's changes:
133136

134137
```
135-
feat/scope-attributes # PR 1
136-
feat/scope-attributes-logger # PR 2
137-
fix/attribute-type-detection # PR 3 (fix, different name — that's fine)
138+
feat/scope-attributes # collection branch → targets main
139+
feat/scope-attributes-api # PR 1 → targets collection branch
140+
feat/scope-attributes-logger # PR 2 → targets PR 1
141+
fix/attribute-type-detection # PR 3 (fix, different name — that's fine) → targets PR 2
138142
```
139143

140144
### PR Title Naming
@@ -158,68 +162,91 @@ Do **not** rely on branch name patterns — later PRs in a stack may use differe
158162
```bash
159163
gh pr list --head "$(git branch --show-current)" --json number,title,baseRefName --jq '.[0]'
160164
```
161-
2. Read the stack comment on that PR — it lists every PR in the stack.
162-
3. If there is no stack comment yet, walk the chain in both directions:
165+
2. Read the PR description — the stack list is at the top of the body.
166+
3. If there is no stack list yet, walk the chain in both directions:
163167
```bash
164168
# Find the PR whose head branch is the current PR's base (go up)
165169
gh pr list --head <baseRefName> --json number,title,baseRefName
166170

167171
# Find PRs whose base branch is the current PR's head (go down)
168172
gh pr list --base <currentBranch> --json number,title,headRefName
169173
```
170-
Repeat until you reach `main` going up and find no more PRs going down.
174+
Repeat until you reach the collection branch going up and find no more PRs going down.
175+
176+
### Creating the Collection Branch
177+
178+
Before the first stacked PR, create the collection branch with an empty commit (so GitHub allows opening a PR) and create the collection PR:
179+
180+
```bash
181+
git checkout main
182+
git checkout -b feat/<topic>
183+
git commit --allow-empty -m "collection: <topic>"
184+
git push -u origin HEAD
185+
gh pr create --base main --draft --title "<type>(<scope>): <Topic>" --body "Collection PR for the <Topic> stack. Squash-merge this once all stack PRs are merged."
186+
```
187+
188+
**CRITICAL: Do NOT manually update the collection branch.** Never merge, fast-forward, or push stack branch commits into the collection branch. The collection branch stays at its initial position (the empty commit on `main`) until the user merges individual stack PRs into it one by one through GitHub. If you fast-forward the collection branch to include stack commits, GitHub will auto-merge and delete all stack PR branches, destroying the entire stack.
171189

172190
### Creating a New Stacked PR
173191

174-
1. Start from the tip of the previous stack branch (or `main` for the first PR).
192+
1. Start from the tip of the previous stack branch (or the collection branch for the first PR).
175193
2. Create a new branch, make changes, format, commit, and push.
176-
3. Create the PR with `--base <previous-branch>`:
194+
3. Create the PR with `--base <previous-branch>` (the collection branch for the first PR):
177195
```bash
178196
gh pr create --base feat/previous-branch --draft --title "<type>(<scope>): [<Topic> <N>] <Subject>" --body "..."
179197
```
180-
4. Add the stack comment to the new PR and update it on all existing PRs in the stack (see below).
198+
4. Add the stack list to the top of the new PR's description and update it on all existing PRs in the stack (see below).
181199

182-
### Stack Comment
200+
### Stack List in PR Description
183201

184-
Every PR in the stack must have a comment listing all PRs in the stack. When a new PR is added, update the comment on **all** PRs in the stack.
202+
Every PR in the stack — **including the collection branch PR** — must have a stack list **at the top of its description** (before the `## :scroll: Description` section). When a new PR is added, update the description on **all** PRs in the stack and on the collection branch PR.
185203

186204
Format:
187205

188206
```markdown
189207
## PR Stack (<Topic>)
190208

191-
- [#5118](https://github.com/getsentry/sentry-java/pull/5118) — Add scope-level attributes API
192-
- [#5120](https://github.com/getsentry/sentry-java/pull/5120) — Wire scope attributes into LoggerApi and MetricsApi
193-
- [#5121](https://github.com/getsentry/sentry-java/pull/5121) — Showcase scope attributes in Spring Boot 4 samples
209+
- #5118
210+
- #5120
211+
- #5121
212+
213+
---
194214
```
195215

196-
No status column — GitHub already shows that.
216+
No status column — GitHub already shows that. The `---` separates the stack list from the rest of the PR description.
197217

198-
To add or update the stack comment on a PR:
218+
**Merge method reminder:** On stack PRs (not the collection branch PR), add the following line at the very end of the PR description:
199219

200-
```bash
201-
# Find existing stack comment (if any)
202-
gh api repos/getsentry/sentry-java/issues/<PR_NUMBER>/comments --jq '.[] | select(.body | startswith("## PR Stack")) | .id'
220+
```markdown
221+
> ⚠️ **Merge this PR using a merge commit** (not squash). Only the collection branch is squash-merged into main.
222+
```
203223

204-
# Create new comment
205-
gh pr comment <PR_NUMBER> --body "<stack comment body>"
224+
This does not apply to standalone PRs or the collection branch PR.
206225

207-
# Or update existing comment
208-
gh api repos/getsentry/sentry-java/issues/comments/<COMMENT_ID> -X PATCH -f body="<stack comment body>"
209-
```
226+
To update the PR description, use `--body-file` to avoid shell quoting issues with special characters in the body.
227+
228+
**Important:** Do not use shell redirects (`>`, `>>`, `|`) or compound commands (`&&`, `||`). These create compound shell expressions that won't match permission patterns. Instead, use the `Write` and `Edit` tools for file manipulation:
210229

211-
### Merging Stacked PRs
230+
1. Read the current body with `gh pr view <PR_NUMBER> --json body --jq '.body'` (the output is returned directly — use the `Write` tool to save it to `/tmp/pr-body.md`)
231+
2. Use the `Edit` tool to prepend or replace the stack list section in `/tmp/pr-body.md`
232+
3. Update the description: `gh pr edit <PR_NUMBER> --body-file /tmp/pr-body.md`
212233

213-
Merge in order from bottom to top (PR 1 first, then PR 2, etc.). After each merge, the next PR's base automatically becomes the merged branch's target. GitHub handles rebasing onto the new base. Verify each PR's diff still looks correct after the previous one merges.
234+
### Merging Stacked PRs (done by the user, not the agent)
235+
236+
Individual stack PRs are merged in order from bottom to top (PR 1 first, then PR 2, etc.) using **merge commits** (not squash). After each merge, the next PR's base automatically becomes the merged branch's target. GitHub handles rebasing onto the new base.
237+
238+
Once all stack PRs are merged into the collection branch, the collection PR is **squash-merged** into `main`. This gives `main` a clean single commit for the entire feature.
239+
240+
**Do not merge PRs.** Only the user merges PRs.
214241

215242
### Syncing the Stack
216243

217-
When a base PR changes (e.g. after addressing review feedback on PR 1), merge the changes forward through the stack:
244+
When a base PR changes (e.g. after addressing review feedback on PR 1), merge the changes forward through the stack **between adjacent stack PR branches only**:
218245

219246
```bash
220247
# On the branch for PR 2
221248
git checkout feat/scope-attributes-logger
222-
git merge feat/scope-attributes
249+
git merge feat/scope-attributes-api
223250
git push
224251

225252
# On the branch for PR 3
@@ -228,4 +255,6 @@ git merge feat/scope-attributes-logger
228255
git push
229256
```
230257

258+
**Never merge into the collection branch.** Syncing only happens between stack PR branches. The collection branch is untouched until the user merges PRs through GitHub.
259+
231260
Prefer merge over rebase — it preserves commit history, doesn't invalidate existing review comments, and avoids the need for force-pushing. Only rebase if explicitly requested.

.github/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
* @adinauer @romtsn @markushi @lcian
1+
* @adinauer @romtsn @markushi
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Check Tombstone Proto Schema
2+
3+
on:
4+
schedule:
5+
- cron: '0 9 * * *'
6+
workflow_dispatch:
7+
8+
jobs:
9+
check:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- uses: actions/checkout@v6
14+
15+
- name: Check for newer Tombstone proto schema
16+
run: ./scripts/check-tombstone-proto-schema.sh

0 commit comments

Comments
 (0)