Skip to content

Commit

Permalink
[docs, .github] Add new issue template for stabilizing a module (open…
Browse files Browse the repository at this point in the history
…-telemetry#8935)

This adds a new release template for stabilizing a module.
The intent is to try this out for pdata and featuregate, and iterate on
the template over time.
  • Loading branch information
mx-psi authored and pantuza committed Dec 8, 2023
1 parent 23b3dd8 commit cf2ff56
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 0 deletions.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/stabilization.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Module stabilization
about: Stabilize a module before a 1.0 release
title: 'Stabilize module X'
labels: 'stabilization'
assignees: ''
---

Before stabilizing a module, an approver or maintainer must make sure that the following criteria are met:

- [ ] One RC release or more have been done of this module
- [ ] No open issues or PRs in the module that would require breaking changes
- [ ] No TODOs in the module code that would require breaking changes
- [ ] No deprecated symbols in the module
- [ ] No symbols marked as experimental in the module
- [ ] The module follows the [Coding guidelines](https://github.com/open-telemetry/opentelemetry-collector/blob/main/CONTRIBUTING.md)

Please also make sure to publicly announce our intent to stabilize the module on:

- [ ] The #otel-collector CNCF Slack Channel
- [ ] The #opentelemetry CNCF Slack channel
- [ ] A Collector SIG meeting (if unable to attend, just add to the agenda)

To help other people verify the above criteria, please link to an RC release, the announcement and other links used to complete the above in a comment on this issue.
4 changes: 4 additions & 0 deletions docs/release.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,10 @@ The following documents the procedure to release a bugfix
7. Once the branch has been merged, it will be auto-deleted. Restore the release branch via GitHub.
8. Once the patch is release, disable the **Merge pull request** setting.
## 1.0 release
Stable modules adhere to our [versioning document guarantees](../VERSIONING.md), so we need to be careful before releasing. Before adding a module to the stable module set and making a first 1.0 release, please [open a new stabilization issue](https://github.com/open-telemetry/opentelemetry-collector/issues/new/choose) and follow the instructions in the issue template.
## Release schedule
| Date | Version | Release manager |
Expand Down

0 comments on commit cf2ff56

Please sign in to comment.