Skip to content

Commit f17011a

Browse files
committed
chore: add release notes step to release instructions
1 parent dc6bbb5 commit f17011a

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,19 +57,32 @@ _For this example, we will use the tag `v0.1.0`. This tag already exists, so you
5757

5858
Create a proper SemVer compatible tag. Consult the [SemVer specification](https://semver.org/spec/v2.0.0.html) if you are unsure what this means.
5959

60-
`git tag v0.1.0`
60+
```bash
61+
git tag v0.1.0
62+
```
6163

6264
**Step 2**
6365

6466
Push the tag GitHub.
6567

66-
`git push origin v0.1.0`
68+
```bash
69+
git push origin v0.1.0
70+
```
6771

6872
This command will trigger the [Release GitHub Action](https://github.com/posit-dev/posit-sdk-py/actions/workflows/release.yaml).
6973

74+
Once complete, the release will be available on [PyPI](https://pypi.org/project/posit-sdk).
75+
7076
**Step 3**
7177

72-
Once complete, the release will be available on [PyPI](https://pypi.org/project/posit-sdk).
78+
Create a release on GitHub. Please following the pattern established in previous releases. Set the title to the tag name (e.g., `v0.1.0`) and the body to the generated release notes. For reference, see <https://github.com/posit-dev/posit-sdk-py/releases>.
79+
80+
You can do this via the GitHub UI or using the following command:
81+
82+
```bash
83+
gh release create v0.1.0 --verify-tag --generate-notes --discussion-category "Announcements"`
84+
```
85+
7386

7487
### Pre-Releases
7588

0 commit comments

Comments
 (0)