|
15 | 15 | * [Close the Connection](#close-the-connection)
|
16 | 16 | * [License](#License)
|
17 | 17 | * [How to Get Support and Contribute](#how-to-get-support-and-contribute)
|
| 18 | +* [How to Release](#how-to-release) |
18 | 19 |
|
19 | 20 | # Welcome to the Wavefront Python SDK
|
20 | 21 |
|
@@ -503,3 +504,19 @@ total_failures = wavefront_sender.get_failure_count()
|
503 | 504 | the minor and patch versions.
|
504 | 505 | * Reach out to us on our public [Slack channel](https://www.wavefront.com/join-public-slack).
|
505 | 506 | * If you run into any issues, let us know by creating a GitHub issue.
|
| 507 | + |
| 508 | +## How to Release |
| 509 | + |
| 510 | +1. Merge all the changes that need to go into the release to the master branch. |
| 511 | +2. Open the `setup.py` file from the top level directory of the project. |
| 512 | +3. Search for `version=` in the file to find the version number for example `1.8.10`. |
| 513 | +4. Log into Github, click **Releases** on the right, and click **Draft a new release**. |
| 514 | +5. For **Choose a tag**, choose the version you found in step 3, and prefix it with `v` for example `v1.8.10`. You need to enter the version where it says **Find or create new tag**. |
| 515 | + |
| 516 | +<img src="images/choose-version.png" alt="A diagram that shows how to choose version"/> |
| 517 | + |
| 518 | +6. Provide a short but descriptive title for the release. |
| 519 | +7. Fill in the details of the release. Please copy the markdown from the previous release and follow the same format. |
| 520 | +8. Click **Publish release.** to start publishing the release to pypi.org. |
| 521 | +9. From the Github top navigation bar of this project, click the **Actions** tab. On the first line of the list of workflows, you should see a workflow running that will publish your release to pypi.org. |
| 522 | +10. When the workflow from step 9 has a green checkmark next to it, go to [pypi.org](https://pypi.org/project/wavefront-sdk-python/) and verify that the latest version is published. |
0 commit comments