|
| 1 | +--- |
| 2 | +globs: CHANGELOG.md |
| 3 | +alwaysApply: false |
| 4 | +--- |
| 5 | +# Sentry Symfony SDK Release Process |
| 6 | + |
| 7 | +## Release Process |
| 8 | + |
| 9 | +To prepare a new release (e.g., version 4.14.0): |
| 10 | + |
| 11 | +1. **Update master branch**: Always ensure master is up-to-date first |
| 12 | + ```bash |
| 13 | + git checkout master |
| 14 | + git pull origin master |
| 15 | + ``` |
| 16 | + |
| 17 | +2. **Create release branch**: Create a branch named `prepare-X.Y.Z` |
| 18 | + ```bash |
| 19 | + git checkout -b prepare-4.14.0 |
| 20 | + ``` |
| 21 | + |
| 22 | +3. **Find changes since last release**: Check commits since the last version tag |
| 23 | + ```bash |
| 24 | + git log --oneline --no-merges 4.13.0..HEAD |
| 25 | + ``` |
| 26 | + |
| 27 | +4. **Update CHANGELOG.md**: Add new version section with: |
| 28 | + - Version number and announcement text |
| 29 | + - Features section for new features |
| 30 | + - Bug Fixes section for bug fixes |
| 31 | + - Misc section for documentation/readme updates |
| 32 | + - Use format: `- Description [(#PR)](mdc:https:/github.com/getsentry/sentry-symfony/pull/PR)` |
| 33 | + |
| 34 | +## CHANGELOG.md Format |
| 35 | + |
| 36 | +```markdown |
| 37 | +## X.Y.Z |
| 38 | + |
| 39 | +The Sentry SDK team is happy to announce the immediate availability of Sentry PHP SDK vX.Y.Z. |
| 40 | + |
| 41 | +### Features |
| 42 | + |
| 43 | +- New feature description [(#1234)](mdc:https:/github.com/getsentry/sentry-php/pull/1234) |
| 44 | + |
| 45 | +### Bug Fixes |
| 46 | + |
| 47 | +- Bug fix description [(#1235)](mdc:https:/github.com/getsentry/sentry-php/pull/1235) |
| 48 | + |
| 49 | +### Misc |
| 50 | + |
| 51 | +- Documentation/misc changes [(#1236)](mdc:https:/github.com/getsentry/sentry-php/pull/1236) |
| 52 | +``` |
| 53 | + |
| 54 | +## Committing Changes |
| 55 | + |
| 56 | +After updating CHANGELOG.md: |
| 57 | + |
| 58 | +1. **Stage only the changelog**: `git add CHANGELOG.md` |
| 59 | +2. **Create simple commit**: `git commit -m "Prepare X.Y.Z"` |
| 60 | + - Use simple commit message format |
| 61 | + - Don't include additional descriptions or generated tags |
| 62 | + |
| 63 | +## Common Commands |
| 64 | + |
| 65 | +- Check git status: `git status` |
| 66 | +- View recent commits: `git log --oneline -10` |
| 67 | +- Create branch: `git checkout -b branch-name` |
| 68 | +- Update from remote: `git pull origin master` |
0 commit comments