You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
1.**Apply the Label**: Add the `deprecation` label to your PR
97
-
2.**Respond to Automation**: A bot will comment with guidance on documenting the deprecation
98
-
3.**Provide Deprecation Details**: Add details to your PR description or as a comment, including:
99
-
- What is being deprecated and why
100
-
- What should be used instead (if applicable)
101
-
- Timeline for removal (if known)
102
-
- Any migration guidance
103
-
104
-
### For Maintainers
105
-
106
-
During PR review, ensure:
107
-
- Migration notes are clear
108
-
- The breaking change is properly categorized
109
-
- The impact is well understood
110
-
111
-
### Automation Details
112
-
113
-
The breaking changes automation includes:
114
-
115
-
-**PR Comment Bot** (`.github/workflows/breaking-change-pr-comment.yml`): Automatically comments on PRs with the `breaking change` label, providing guidance and a checklist for the author
116
-
-**Changelog Integration** (`.github/scripts/extract-breaking-changes.sh`): Extracts PRs with breaking change labels and includes them in the changelog template
- Included in the "Breaking Changes" section of the changelog template generated by `draft-change-log-entries.sh`
121
-
- Highlighted at the top of GitHub release notes with links to the original PRs
122
-
- Linked to migration notes provided by contributors
123
-
124
-
### Label Requirements
125
-
126
-
-**Label Name**: `breaking change` (exact match, case sensitive)
127
-
-**When to Use**:
128
-
- API changes that break backward compatibility
129
-
- Configuration changes that require user action
130
-
- Behavioral changes that might affect existing users
131
-
- Removal of deprecated features
132
-
133
77
## Credentials
134
78
135
79
Same as the core repo, see [opentelemetry-java/RELEASING.md#credentials](https://github.com/open-telemetry/opentelemetry-java/blob/main/RELEASING.md#credentials).
0 commit comments