You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: RELEASING.md
+5-11Lines changed: 5 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,27 +7,21 @@ This project does not have a strict release schedule. However, we would make a r
7
7
- No release will be done if no changes got merged to the `master` branch during the above mentioned window.
8
8
- Releases may be done more frequently than the above mentioned window.
9
9
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
-
16
10
## Release Process
17
11
Our team will trigger the release pipeline.
18
12
19
13
### Prerequisite
20
14
- 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
22
15
23
16
### Update Changelog
24
17
#### Commands
25
18
- 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.
26
19
- 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
28
24
29
25
### Release
30
26
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