Skip to content

Commit f19747e

Browse files
committed
feedback
1 parent f17011a commit f19747e

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -53,20 +53,24 @@ 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

6064
```bash
61-
git tag v0.1.0
65+
git $TAG v0.1.0
6266
```
6367

6468
**Step 2**
6569

6670
Push the tag GitHub.
6771

6872
```bash
69-
git push origin v0.1.0
73+
git push origin $TAG
7074
```
7175

7276
This command will trigger the [Release GitHub Action](https://github.com/posit-dev/posit-sdk-py/actions/workflows/release.yaml).
@@ -75,15 +79,14 @@ Once complete, the release will be available on [PyPI](https://pypi.org/project/
7579

7680
**Step 3**
7781

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

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

8286
```bash
83-
gh release create v0.1.0 --verify-tag --generate-notes --discussion-category "Announcements"`
87+
gh release create $TAG --verify-tag --generate-notes --discussion-category "Announcements"`
8488
```
8589

86-
8790
### Pre-Releases
8891

8992
Any tags denoted as a pre-release as defined by the [SemVer 2.0.0](https://semver.org/spec/v2.0.0.html) specification will be marked as such in GitHub. For example, the `v0.1.rc1` is a pre-release. Tag `v0.1.0` is a standard-release. Please consult the specification for additional information.

0 commit comments

Comments
 (0)