Skip to content

Commit

Permalink
Add release instructions to README (#99)
Browse files Browse the repository at this point in the history
  • Loading branch information
keep94 authored Sep 12, 2022
1 parent 64ffc3f commit 5ce2efc
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 1 deletion.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
* [Close the Connection](#close-the-connection)
* [License](#License)
* [How to Get Support and Contribute](#how-to-get-support-and-contribute)
* [How to Release](#how-to-release)

# Welcome to the Wavefront Python SDK

Expand Down Expand Up @@ -503,3 +504,19 @@ total_failures = wavefront_sender.get_failure_count()
the minor and patch versions.
* Reach out to us on our public [Slack channel](https://www.wavefront.com/join-public-slack).
* If you run into any issues, let us know by creating a GitHub issue.

## How to Release

1. Merge all the changes that need to go into the release to the master branch.
2. Open the `setup.py` file from the top level directory of the project.
3. Search for `version=` in the file to find the version number for example `1.8.10`.
4. Log into Github, click **Releases** on the right, and click **Draft a new release**.
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**.

<img src="images/choose-version.png" alt="A diagram that shows how to choose version"/>

6. Provide a short but descriptive title for the release.
7. Fill in the details of the release. Please copy the markdown from the previous release and follow the same format.
8. Click **Publish release.** to start publishing the release to pypi.org.
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.
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.
Binary file added images/choose-version.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

setuptools.setup(
name='wavefront-sdk-python',
version='1.8.10', # The version number. Update with each pull request.
version='1.8.11', # The version number. Update with each pull request.
author='Wavefront by VMware',
url='https://github.com/wavefrontHQ/wavefront-sdk-python',
license='Apache-2.0',
Expand Down

0 comments on commit 5ce2efc

Please sign in to comment.