Skip to content

chore: add release notes step to release instructions #412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 20, 2025
Merged

chore: add release notes step to release instructions #412

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f17011a
chore: add release notes step to release instructions
tdstein May 20, 2025
f19747e
feedback
tdstein May 20, 2025
b55613a
Update CONTRIBUTING.md
tdstein May 20, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,23 +53,39 @@ To start a release create a semver compatible tag.

_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._

```bash
export TAG=v0.1.0
```

**Step 1**

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.

`git tag v0.1.0`
```bash
git tag $TAG
```

**Step 2**

Push the tag GitHub.

`git push origin v0.1.0`
```bash
git push origin $TAG
```

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

Once complete, the release will be available on [PyPI](https://pypi.org/project/posit-sdk).

**Step 3**

Once complete, the release will be available on [PyPI](https://pypi.org/project/posit-sdk).
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>.

You can do this via the GitHub UI or using the following command:

```bash
gh release create $TAG --verify-tag --generate-notes --discussion-category "Announcements"`
```

### Pre-Releases

Expand Down