Skip to content

Commit 12c4662

Browse files
authored
Update release instructions (#143)
1 parent 0db6094 commit 12c4662

File tree

1 file changed

+5
-11
lines changed

1 file changed

+5
-11
lines changed

RELEASING.md

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,21 @@ This project does not have a strict release schedule. However, we would make a r
77
- No release will be done if no changes got merged to the `master` branch during the above mentioned window.
88
- Releases may be done more frequently than the above mentioned window.
99

10-
## Make Sure Everything Works
11-
* Make sure tests are passing.
12-
- Locally and in the continuous integration system.
13-
* Make sure documentation is up-to-date and building correctly.
14-
* Build the package locally (e.g. `python3 setup.py sdist`), install it into a fresh virtualenv and test the changes that have been made since the last release.
15-
1610
## Release Process
1711
Our team will trigger the release pipeline.
1812

1913
### Prerequisite
2014
- Install [datadog_checks_dev](https://datadog-checks-base.readthedocs.io/en/latest/datadog_checks_dev.cli.html#installation) using Python 3.
21-
- Setup PyPI, see the internal documentation for more details
2215

2316
### Update Changelog
2417
#### Commands
2518
- See changes ready for release by running `ddev release show changes .` at the root of this project. Add any missing labels to PRs if needed.
2619
- Run `ddev release changelog . <NEW_VERSION>` to update the `CHANGELOG.md` file at the root of this repository
27-
- Commit the changes to the repository in a release branch and open a PR. Do not merge yet.
20+
- Commit the changes to the repository in a release branch and open a PR.
21+
- Ensure CI passes fully here, this is the commit that will be released!
22+
- Ensure the [documentation builds](https://readthedocs.org/projects/datadog-api-client/builds/) are passing
23+
- Get this PR approved and merged
2824

2925
### Release
3026
1. Create the release on GitHub. [Example](https://github.com/DataDog/datadog-api-client-python/releases/tag/1.0.0b1)
31-
1. Checkout the tag created at the previous step.
32-
1. Run `ddev release build .` and `ddev release upload . `.
33-
- Make sure that both an `sdist` and a [universal wheel](https://packaging.python.org/guides/distributing-packages-using-setuptools/#universal-wheels) have been uploaded to [PyPI](https://pypi.python.org/pypi/datadog/).
27+
1. A github action will kick off that builds and publishes this tag to PyPI. Confirm the [release is available](https://pypi.org/project/datadog-api-client/#history)

0 commit comments

Comments
 (0)