Skip to content

Commit 6bed105

Browse files
authored
chore: add a discussion template for major version releases (#427)
1 parent d8fd15d commit 6bed105

1 file changed

Lines changed: 104 additions & 0 deletions

File tree

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
title: "[Major Release]: "
2+
labels: ["major-release", "breaking-change"]
3+
body:
4+
- type: markdown
5+
attributes:
6+
value: |
7+
Use this template to propose a major version release. Major releases include breaking changes
8+
that require careful planning, communication, and migration support.
9+
10+
- type: input
11+
id: proposed-version
12+
attributes:
13+
label: Proposed Version Number
14+
description: The target major version number for this release
15+
placeholder: "e.g., 2.0.0"
16+
validations:
17+
required: true
18+
19+
- type: textarea
20+
id: breaking-changes
21+
attributes:
22+
label: Description of the Breaking Changes
23+
description: List all breaking changes included in this release with clear before/after examples
24+
placeholder: |
25+
1. **Change**: Description of the breaking change
26+
- Before: `old_api()`
27+
- After: `new_api()`
28+
29+
2. **Change**: Description of the breaking change
30+
- Before: ...
31+
- After: ...
32+
validations:
33+
required: true
34+
35+
- type: textarea
36+
id: justification
37+
attributes:
38+
label: Justification for the Changes
39+
description: Explain why these breaking changes are necessary and what problems they solve
40+
placeholder: |
41+
- Why can't this be done in a backward-compatible way?
42+
- What user pain points or technical debt does this address?
43+
- What benefits do users gain from upgrading?
44+
validations:
45+
required: true
46+
47+
- type: textarea
48+
id: consuming-code-changes
49+
attributes:
50+
label: Changes Needed in Consuming Code
51+
description: Describe what consumers of this SDK need to change in their code to adopt the new version
52+
placeholder: |
53+
- Step-by-step migration instructions
54+
- Code examples showing required changes
55+
- Any tooling or codemods available to assist migration
56+
validations:
57+
required: true
58+
59+
- type: textarea
60+
id: inflight-impact
61+
attributes:
62+
label: Impact to In-flight Executions
63+
description: Describe how this release affects durable executions that are currently in progress
64+
placeholder: |
65+
- Can in-flight executions continue running after upgrade?
66+
- Is there a required draining period?
67+
- Are checkpointed states compatible across versions?
68+
- What happens to executions that are suspended (waiting)?
69+
validations:
70+
required: true
71+
72+
- type: textarea
73+
id: alternatives
74+
attributes:
75+
label: Alternatives Explored
76+
description: Describe alternative approaches that were considered and why they were not chosen
77+
placeholder: |
78+
1. **Alternative**: Description
79+
- Pros: ...
80+
- Cons: ...
81+
- Why rejected: ...
82+
validations:
83+
required: true
84+
85+
- type: textarea
86+
id: deprecation-changes
87+
attributes:
88+
label: Deprecation Changes Required for Previous Versions
89+
description: Describe deprecation notices, warnings, or shims that should be added to the current major version before this release
90+
placeholder: |
91+
- What deprecation warnings should be added to the current release?
92+
- What is the proposed deprecation timeline?
93+
- Are there compatibility shims or adapters to ease migration?
94+
validations:
95+
required: true
96+
97+
- type: textarea
98+
id: additional-context
99+
attributes:
100+
label: Additional Context
101+
description: Any other context, timeline considerations, or references
102+
placeholder: Additional information...
103+
validations:
104+
required: false

0 commit comments

Comments
 (0)