Skip to content

Commit 0837da5

Browse files
authored
Add release doc (#125)
* Add releasing doc * fix example link
1 parent 7f7a98a commit 0837da5

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

RELEASING.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Releasing
2+
This document summarizes the process of doing a new release of this project.
3+
Release can only be performed by Datadog maintainers of this repository.
4+
5+
## Schedule
6+
This project does not have a strict release schedule. However, we would make a release at least every 2 months.
7+
- No release will be done if no changes got merged to the `master` branch during the above mentioned window.
8+
- Releases may be done more frequently than the above mentioned window.
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+
## Release Process
17+
Our team will trigger the release pipeline.
18+
19+
### Prerequisite
20+
- 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+
23+
### Update Changelog
24+
#### Commands
25+
- 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+
- 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.
28+
29+
### Release
30+
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/).

0 commit comments

Comments
 (0)