Skip to content

Commit db828ce

Browse files
authored
[docs] Tweak releasing guide for new automation around release notes (open-telemetry#6089)
1 parent ef090ad commit db828ce

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

build/RELEASING.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -80,11 +80,21 @@ Maintainers (admins) are needed to merge PRs and for the push to NuGet.**
8080
for the projects being released.
8181
</details
8282
83-
3. :stop_sign: The PR opened by [Prepare for a
83+
3. For stable releases, use the `/UpdateReleaseNotes` command on the PR opened
84+
by [Prepare for a
85+
release](https://github.com/open-telemetry/opentelemetry-dotnet/actions/workflows/prepare-release.yml)
86+
workflow in step 2 to update [Release Notes](../RELEASENOTES.md) with any
87+
big or interesting new features.
88+
89+
* The `/UpdateReleaseDates` command may also be used to update dates in
90+
`CHANGELOG.md` files. This is useful when the PR is opened a few days
91+
before the planned release date to review public API changes.
92+
93+
4. :stop_sign: The PR opened by [Prepare for a
8494
release](https://github.com/open-telemetry/opentelemetry-dotnet/actions/workflows/prepare-release.yml)
8595
workflow in step 2 has to be merged.
8696
87-
4. Once the PR opened by [Prepare for a
97+
5. Once the PR opened by [Prepare for a
8898
release](https://github.com/open-telemetry/opentelemetry-dotnet/actions/workflows/prepare-release.yml)
8999
workflow in step 2 has been merged a trigger will automatically add a
90100
comment and lock the PR. Post a comment with "/CreateReleaseTag" in the
@@ -123,7 +133,7 @@ Maintainers (admins) are needed to merge PRs and for the push to NuGet.**
123133
workflow.
124134
</details>
125135

126-
5. :stop_sign: Wait for the [Build, pack, and publish to
136+
6. :stop_sign: Wait for the [Build, pack, and publish to
127137
MyGet](https://github.com/open-telemetry/opentelemetry-dotnet/actions/workflows/publish-packages-1.0.yml)
128138
workflow to complete. When complete a trigger will automatically add a
129139
comment on the PR opened by [Prepare for a
@@ -187,14 +197,14 @@ Maintainers (admins) are needed to merge PRs and for the push to NuGet.**
187197
draft Release and click `Publish release`.
188198
</details>
189199
190-
6. If a new stable version of the core packages was released, a PR should have
200+
7. If a new stable version of the core packages was released, a PR should have
191201
been automatically created by the [Complete
192202
release](https://github.com/open-telemetry/opentelemetry-dotnet/actions/workflows/post-release.yml)
193203
workflow to update the `OTelLatestStableVer` property in
194204
`Directory.Packages.props` to the just released stable version. Merge that
195205
PR once the build passes (this requires the packages be available on NuGet).
196206
197-
7. The [Complete
207+
8. The [Complete
198208
release](https://github.com/open-telemetry/opentelemetry-dotnet/actions/workflows/post-release.yml)
199209
workflow should have invoked the [Core version
200210
update](https://github.com/open-telemetry/opentelemetry-dotnet-contrib/actions/workflows/core-version-update.yml)
@@ -203,7 +213,6 @@ Maintainers (admins) are needed to merge PRs and for the push to NuGet.**
203213
repository which opens a PR to update dependencies. Verify this PR was
204214
opened successfully.
205215
206-
8. For stable releases, update [Release Notes](../RELEASENOTES.md) with any big
207-
or interesting new features and then post an announcement in the [Slack
208-
channel](https://cloud-native.slack.com/archives/C01N3BC2W7Q) with the same
209-
information.
216+
9. For stable releases post an announcement in the [Slack
217+
channel](https://cloud-native.slack.com/archives/C01N3BC2W7Q) announcing the
218+
release and link to the release notes.

0 commit comments

Comments
 (0)