From 2095e88e86e96f23db4fcbe4f9a4b467ae5c1817 Mon Sep 17 00:00:00 2001 From: mckadesorensen Date: Thu, 4 Jan 2024 10:36:42 -0900 Subject: [PATCH] feat: update docs to include release notes --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 04969d7..4c27413 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,18 @@ Documentation](https://nasa.github.io/cumulus/docs/deployment/deployment-readme) for detailed information about configuring, deploying, and running Cumulus. +## Generating Releases + +### Naming Schema: +The CIRRUS name schema is `vX.X.X.Y`. The X represents the [Cumulus version](https://github.com/nasa/cumulus/releases), +while the Y represents the CIRRUS version. + +### Backporting Features +A release branch should be created when backporting a feature, such as `release/v17.1.4.2`. +In this case, the release branch `release/v17.1.4.2` should be created from the tag `v17.1.4.1`. +You should then create a PR from your feature branch to the release branch. +Once the PR has been approved and merged, you can create a release based on the release branch. + ## Prerequisites * [Docker](https://www.docker.com/get-started)