Skip to content

Commit f06f3ee

Browse files
committed
Better changlog syntax, agent instructions
1 parent 4767354 commit f06f3ee

File tree

3 files changed

+30
-14
lines changed

3 files changed

+30
-14
lines changed

.github/copilot-instructions.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,17 @@ building durable orchestrations. The repo contains two packages:
88
- `durabletask` — core SDK (in `durabletask/`)
99
- `durabletask.azuremanaged` — Azure Durable Task Scheduler provider (in `durabletask-azuremanaged/`)
1010

11+
## Changelog Requirements
12+
13+
- ALWAYS document user-facing changes in the appropriate changelog under
14+
`## Unreleased`.
15+
- Update `CHANGELOG.md` for core SDK changes and
16+
`durabletask-azuremanaged/CHANGELOG.md` for provider changes.
17+
- If a change affects both packages, update both changelogs.
18+
- Do NOT document internal-only changes in changelogs, including CI/workflow
19+
updates, test-only changes, refactors with no user-visible behavior change,
20+
and implementation details that do not affect public behavior or API.
21+
1122
## Language and Style
1223

1324
- Python 3.10+ is required.

.github/skills/release-prep/SKILL.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,12 @@ Update azuremanaged dependency floors:
5252
- Add a new `## v<version>` section directly under `## Unreleased` in:
5353
- `CHANGELOG.md`
5454
- `durabletask-azuremanaged/CHANGELOG.md`
55-
- Ensure all commits since the previous release tags are represented.
55+
- Ensure user-facing changes since the previous release tags are represented.
5656
- Keep entries concise and grouped by type (`ADDED`, `CHANGED`, `FIXED`, `REMOVED`) where
5757
applicable.
58+
- Exclude internal-only changes from changelogs (for example CI/workflow-only
59+
updates, test-only changes, and implementation refactors with no public
60+
behavior or API impact).
5861

5962
### 4. Validate
6063

@@ -96,6 +99,8 @@ Include:
9699
- Contributor handles from the commit range
97100
- Keep drafts in the assistant response (or PR comment) so they can be pasted
98101
directly into the Releases section
102+
- Keep the release body focused on user-facing changes and avoid internal-only
103+
details (CI/test updates or implementation-only notes)
99104

100105

101106
## Output

CHANGELOG.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -117,72 +117,72 @@ FIXED:
117117

118118
## v0.3.0
119119

120-
### New (v0.3.0)
120+
ADDED
121121

122122
- Added `ConcurrencyOptions` class for fine-grained concurrency control with separate limits for activities and orchestrations. The thread pool worker count can also be configured.
123123

124-
### Fixed (v0.3.0)
124+
FIXED
125125

126126
- Fixed an issue where a worker could not recover after its connection was interrupted or severed
127127

128128
## v0.2.1
129129

130-
### New (v0.2.1)
130+
ADDED
131131

132132
- Added `set_custom_status` orchestrator API ([#31](https://github.com/microsoft/durabletask-python/pull/31)) - contributed by [@famarting](https://github.com/famarting)
133133
- Added `purge_orchestration` client API ([#34](https://github.com/microsoft/durabletask-python/pull/34)) - contributed by [@famarting](https://github.com/famarting)
134134
- Added new `durabletask-azuremanaged` package for use with the [Durable Task Scheduler](https://learn.microsoft.com/azure/azure-functions/durable/durable-task-scheduler/durable-task-scheduler) - by [@RyanLettieri](https://github.com/RyanLettieri)
135135

136-
### Changes (v0.2.1)
136+
CHANGED
137137

138138
- Protos are compiled with gRPC 1.62.3 / protobuf 3.25.X instead of the latest release. This ensures compatibility with a wider range of grpcio versions for better compatibility with other packages / libraries ([#36](https://github.com/microsoft/durabletask-python/pull/36)) - by [@berndverst](https://github.com/berndverst)
139139
- Http and grpc protocols and their secure variants are stripped from the host name parameter if provided. Secure mode is enabled if the protocol provided is https or grpcs ([#38](https://github.com/microsoft/durabletask-python/pull/38) - by [@berndverst)(https://github.com/berndverst)
140140
- Improve ProtoGen by downloading proto file directly instead of using submodule ([#39](https://github.com/microsoft/durabletask-python/pull/39) - by [@berndverst](https://github.com/berndverst)
141141

142-
### Updates (v0.2.1)
142+
CHANGED
143143

144144
- Updated `durabletask-protobuf` submodule reference to latest
145145

146146
## v0.1.1a1
147147

148-
### New (v0.1.1a1)
148+
ADDED
149149

150150
- Add recursive flag in terminate_orchestration to support cascade terminate ([#27](https://github.com/microsoft/durabletask-python/pull/27)) - contributed by [@shivamkm07](https://github.com/shivamkm07)
151151

152152
## v0.1.0
153153

154-
### New (v0.1.0)
154+
ADDED
155155

156156
- Retry policies for activities and sub-orchestrations ([#11](https://github.com/microsoft/durabletask-python/pull/11)) - contributed by [@DeepanshuA](https://github.com/DeepanshuA)
157157

158-
### Fixed (v0.1.0)
158+
FIXED
159159

160160
- Fix try/except in orchestrator functions not being handled correctly ([#21](https://github.com/microsoft/durabletask-python/pull/21)) - by [@cgillum](https://github.com/cgillum)
161161
- Updated `durabletask-protobuf` submodule reference to latest distributed tracing commit - by [@cgillum](https://github.com/cgillum)
162162

163163
## v0.1.0a5
164164

165-
### New (v0.1.0a5)
165+
ADDED
166166

167167
- Adds support for secure channels ([#18](https://github.com/microsoft/durabletask-python/pull/18)) - contributed by [@elena-kolevska](https://github.com/elena-kolevska)
168168

169-
### Fixed (v0.1.0a5)
169+
FIXED
170170

171171
- Fix zero argument values sent to activities as None ([#13](https://github.com/microsoft/durabletask-python/pull/13)) - contributed by [@DeepanshuA](https://github.com/DeepanshuA)
172172

173173
## v0.1.0a3
174174

175-
### New (v0.1.0a3)
175+
ADDED
176176

177177
- Add gRPC metadata option ([#16](https://github.com/microsoft/durabletask-python/pull/16)) - contributed by [@DeepanshuA](https://github.com/DeepanshuA)
178178

179-
### Changes (v0.1.0a3)
179+
CHANGED
180180

181181
- Removed Python 3.7 support due to EOL ([#14](https://github.com/microsoft/durabletask-python/pull/14)) - contributed by [@berndverst](https://github.com/berndverst)
182182

183183
## v0.1.0a2
184184

185-
### New (v0.1.0a2)
185+
ADDED
186186

187187
- Continue-as-new ([#9](https://github.com/microsoft/durabletask-python/pull/9))
188188
- Support for Python 3.7+ ([#10](https://github.com/microsoft/durabletask-python/pull/10)) - contributed by [@DeepanshuA](https://github.com/DeepanshuA)

0 commit comments

Comments
 (0)