Skip to content

Commit def37c7

Browse files
authored
chore: add GitHub release steps to the instructions (#412)
1 parent dc6bbb5 commit def37c7

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -53,23 +53,39 @@ To start a release create a semver compatible tag.
5353

5454
_For this example, we will use the tag `v0.1.0`. This tag already exists, so you will not be able run the following commands verbatim._
5555

56+
```bash
57+
export TAG=v0.1.0
58+
```
59+
5660
**Step 1**
5761

5862
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.
5963

60-
`git tag v0.1.0`
64+
```bash
65+
git tag $TAG
66+
```
6167

6268
**Step 2**
6369

6470
Push the tag GitHub.
6571

66-
`git push origin v0.1.0`
72+
```bash
73+
git push origin $TAG
74+
```
6775

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

78+
Once complete, the release will be available on [PyPI](https://pypi.org/project/posit-sdk).
79+
7080
**Step 3**
7181

72-
Once complete, the release will be available on [PyPI](https://pypi.org/project/posit-sdk).
82+
Create a release on GitHub. Please follow 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. Enable the "Create a discussion for this release" option and set the category to "Announcements". For reference, see <https://github.com/posit-dev/posit-sdk-py/releases>.
83+
84+
You can do this via the GitHub UI or using the following command:
85+
86+
```bash
87+
gh release create $TAG --verify-tag --generate-notes --discussion-category "Announcements"`
88+
```
7389

7490
### Pre-Releases
7591

0 commit comments

Comments
 (0)