Skip to content

Commit 5b5cb61

Browse files
authored
Nit fixes to releasing doc (#1648)
1 parent aa7065f commit 5b5cb61

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

RELEASING.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,24 +24,33 @@ A draft PR can be created, but before releasing consider the following:
2424
## Steps to Release
2525

2626
1. Create a release PR
27-
- For each crate
28-
- Bump appropriate version
29-
- Update change logs to reflect release version.
30-
- Update API/SDK version as necessary
31-
- Attach `integration test` label to the PR to run integration tests
32-
- If there's a large enough set of changes, consider writing a migration guide.
27+
28+
* For each crate
29+
* Bump appropriate version
30+
* Update change logs to reflect release version.
31+
* Update API/SDK version as necessary
32+
* Attach `integration test` label to the PR to run integration tests
33+
* If there's a large enough set of changes, consider writing a migration guide.
34+
3335
2. Merge the PR
34-
- Get reviews from other Maintainers
35-
- Ensure that there haven't been any interfering PRs
36+
37+
* Get reviews from other Maintainers
38+
* Ensure that there haven't been any interfering PRs
39+
3640
3. Tag the release commit based on the [tagging convention](#tagging-convention). It should usually be a bump on minor version before 1.0
3741
4. Create Github Release
3842
5. [Publish](#publishing-crates) to crates.io using the version as of the release commit
3943
6. Post to [#otel-rust](https://cloud-native.slack.com/archives/C03GDP0H023) on CNCF Slack.
4044

41-
4245
## Tagging Convention
4346

4447
For each crate: it should be `<crate-name>-<version>` `<version>` being the simple `X.Y.Z`.
48+
For example:
49+
50+
```sh
51+
git tag -a opentelemetry-http-0.11.1 -m "opentelemetry-http 0.11.1 release"
52+
git push origin opentelemetry-http-0.11.1
53+
```
4554

4655
## Publishing Crates
4756

0 commit comments

Comments
 (0)