Skip to content

Commit 979eb67

Browse files
committed
RELEASE: update release documentation
1 parent b0f162f commit 979eb67

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

RELEASE.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,21 @@
22

33
This document describes the steps to release a new version of the `wit-bindgen-go` CLI.
44

5-
## 1. Update the [CHANGELOG.md](./CHANGELOG.md)
5+
## 1. Update [CHANGELOG.md](./CHANGELOG.md)
66

7-
* Add the latest changes to CHANGELOG.md.
8-
* Rename the Unreleased section to reflect the new version number.
9-
* Update the links to new version tag in the footer of CHANGELOG.md
10-
* Submit a pull request (PR) with these updates.
7+
1. Add the latest changes to [CHANGELOG.md](./CHANGELOG.md).
8+
1. Rename the Unreleased section to reflect the new version number.
9+
1. Update the links to new version tag in the footer of CHANGELOG.md
10+
1. Add today’s date (YYYY-MM-DD) after an em dash (—).
11+
1. Submit a [GitHub Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) with these updates.
1112

1213
## 2. Create a new release
1314

1415
Once the PR is merged, tag the new version in Git and push the tag to GitHub.
1516

1617
For example, to tag version `v0.3.0`:
1718

18-
```sh
19+
```console
1920
git tag v0.3.0
2021
git push origin v0.3.0
2122
```

0 commit comments

Comments
 (0)