From 5978ae3635672f4a68194cb732943c2aa4dd89fd Mon Sep 17 00:00:00 2001 From: Karthik Satchitanand Date: Fri, 15 Nov 2019 21:19:00 +0530 Subject: [PATCH] (chore)updates to project docs (#946) Signed-off-by: ksatchit --- ...aturity.md => CHAOS_EXPERIMENT_MATURITY.md | 0 ...ASE-GUIDELINES.md => RELEASE_GUIDELINES.md | 23 +++++++++---------- 2 files changed, 11 insertions(+), 12 deletions(-) rename contribute/maturity.md => CHAOS_EXPERIMENT_MATURITY.md (100%) rename RELEASE-GUIDELINES.md => RELEASE_GUIDELINES.md (74%) diff --git a/contribute/maturity.md b/CHAOS_EXPERIMENT_MATURITY.md similarity index 100% rename from contribute/maturity.md rename to CHAOS_EXPERIMENT_MATURITY.md diff --git a/RELEASE-GUIDELINES.md b/RELEASE_GUIDELINES.md similarity index 74% rename from RELEASE-GUIDELINES.md rename to RELEASE_GUIDELINES.md index c72525c56cc..76bc7606ab3 100644 --- a/RELEASE-GUIDELINES.md +++ b/RELEASE_GUIDELINES.md @@ -7,10 +7,7 @@ - Repositories use release version according to the [Semantic Versioning](https://semver.org/) -- Docker images with release tags are pushed upon creation of a github release. The CI configuration to enable this can be found on the following repositories: - - [Litmus](https://github.com/litmuschaos/litmus/blob/master/.travis.yml) - - [Chaos-Operator](https://github.com/litmuschaos/chaos-operator/blob/master/.circleci/config.yml) - - [Chaos-Exporter](https://github.com/litmuschaos/chaos-exporter/blob/master/.travis.yml) +- Docker images with release tags are pushed upon creation of a github release (commits to master push images with `ci` tags) - Following are the docker images: - [litmuschaos/ansible-runner](https://cloud.docker.com/u/litmuschaos/repository/docker/litmuschaos/ansible-runner) @@ -19,14 +16,16 @@ - Tracking of releases is done on Github [project board](https://github.com/litmuschaos/litmus/projects) -- The flow of the release is done by the following steps: - - Sprint Planning with feature request from the community - - Development of feature - - RC1 build - - More RC build will be done on a need basis - - Testing is done after the RC1 build - - Cherry picking the commits to the release branch post RC build - - Release is done +- The release flow consists of the following steps: + + - Sprint Planning based on backlogs & feature requests from the community + - Feature Development with unit-tests & integration/bdd (behaviour driven development) tests + - Code/Enhancement freeze with release branch & RC1 (Release Candidate) creation + - User & Dev Documentation + - Execution of (end-to-end) tests against chaos charts, followed by fixes to issues identified + - Cherry pick of commits from master (fixes) to release branch + - Doc sanity tests + - Litmus release with change log - Releases - Pre Release Version (Development)