This document summarizes the process of doing a new release of this project. Release can only be performed by Datadog maintainers of this repository.
This project does not have a strict release schedule. However, we would make a release at least every 2 months.
- No release will be done if no changes got merged to the
masterbranch during the above mentioned window. - Releases may be done more frequently than the above mentioned window.
- Install datadog_checks_dev using Python 3
- Have Node.js 12+
- Ensure all CIs are passing on the master branch that we're about to release.
Note that once the release process is started, nobody should be merging/pushing anything.
Releasing a new version of @datadog/datadog-api-client unfolds as follow:
- See changes ready for release by running
ddev release show changes . --tag-prefix vat the root of this project. Add any missing labels to PRs if needed. - Run
ddev release changelog . <NEW_VERSION> --tag-prefix vto update theCHANGELOG.mdfile at the root of this repository - Update the version in
package.jsonyou want to release, following semver (yarn version --no-git-tag-version --set-version 1.0.0-beta.4). - Commit the changes to the repository in a release branch and get it approved/merged after you:
- Make sure that all CIs are passing, as this is the commit we will be releasing!
- Merge the Pull Request.
- Create a Github Release from the Releases page with the description of changes introduced.
- Set the tag and the release name to new version e.g.
v1.0.0-beta.3. - Paste the changelog in the description.
- Check pre-release box for alpha/beta releases.
- Set the tag and the release name to new version e.g.
- Once the release has been created, a Github Action will publish the package.