From 179ce68ab654dd27c3b64b853951877c7ed9f19b Mon Sep 17 00:00:00 2001 From: Brian Marks Date: Tue, 2 Jul 2024 13:48:03 -0400 Subject: [PATCH] Include information about intended release schedule --- README.md | 5 +++++ docs/releases.md | 13 +++++++++++++ 2 files changed, 18 insertions(+) create mode 100644 docs/releases.md diff --git a/README.md b/README.md index 1325c607673..f98ef7ca129 100644 --- a/README.md +++ b/README.md @@ -41,3 +41,8 @@ Then check our guides: Or our reference documents: * [How instrumentations work](docs/how_instrumentations_work.md). + +## Releases +Datadog will generally create a new minor release the first full week of every month. + +See [release.md](docs/releases.md) for more information. diff --git a/docs/releases.md b/docs/releases.md new file mode 100644 index 00000000000..5d941456c2f --- /dev/null +++ b/docs/releases.md @@ -0,0 +1,13 @@ +# Releases +Datadog will generally create a new minor release the first full week of every month. + +## Release Types +The release workflow depends on the release type: + +- **Minor release**: The **default release workflow** done on a monthly basis. It will ship the latest changes from the `master` branch. +- **Patch release**: Done when needed only. It will start from a minor release branch (release/vM.N.x) and includes important fixes only. +- **Major release**: Done exceptionally. It marks an important compatibility break. +- **Snapshot release**: Done automatically for every PR. + +In addition to the release types, most releases can be: +- **Release candidate**: Major, minor and patch release can be candidate, meaning they won’t be promoted, but can still be used for testing.