diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 65509e4fc5f..2befb8dadb6 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -8,23 +8,23 @@ * [ ] Does this PR have a corresponding GitHub issue? * [ ] Have you included relevant README for the chaoslib/experiment with details? -* [ ] Have you added debug messages where necessary? -* [ ] Have you added task comments where necessary? +* [ ] Have you added debug messages where necessary? +* [ ] Have you added task comments where necessary? * [ ] Have you tested the changes for possible failure conditions? * [ ] Have you provided the positive & negative test logs for the litmusbook execution? * [ ] Does the litmusbook ensure idempotency of cluster state?, i.e., is cluster restored to original state? * [ ] Have you used non-shell/command modules for Kubernetes tasks? -* [ ] Have you (jinja) templatized custom scripts that is run by the litmusbook, if any? +* [ ] Have you (jinja) templatized custom scripts that is run by the litmusbook, if any? * [ ] Have you (jinja) templatized Kubernetes deployment manifests used by the litmusbook, if any? * [ ] Have you reused/created util functions instead of repeating tasks in the litmusbook? -* [ ] Do the artifacts follow the appropriate directory structure? -* [ ] Have you isolated storage (eg: OpenEBS) specific implementations, checks? -* [ ] Have you isolated platform (eg: baremetal kubeadm/openshift/aws/gcloud) specific implementations, checks? +* [ ] Do the artifacts follow the appropriate directory structure? +* [ ] Have you isolated storage (eg: OpenEBS) specific implementations, checks? +* [ ] Have you isolated platform (eg: baremetal kubeadm/openshift/aws/gcloud) specific implementations, checks? * [ ] Are the ansible facts well defined? Is the scope explicitly set for playbook & included utils? * [ ] Have you ensured minimum/careful usage of shell utilities (awk, grep, sed, cut, xargs etc.,)? * [ ] Can the limtusbook be executed both from within & outside a container (configurable paths, no hardcode)? * [ ] Can you suggest the minimal resource requirements for the litmusbook execution? * [ ] Does the litmusbook job artifact carry comments/default options/range for the ENV tunables? -* [ ] Has the litmusbooks been linted? +* [ ] Has the litmusbooks been linted? **Special notes for your reviewer**: diff --git a/RELEASE_GUIDELINES.md b/RELEASE_GUIDELINES.md index 95ebf53deb3..b9434db58c2 100644 --- a/RELEASE_GUIDELINES.md +++ b/RELEASE_GUIDELINES.md @@ -17,39 +17,38 @@ - [litmuschaos/chaos-runner](https://cloud.docker.com/u/litmuschaos/repository/docker/litmuschaos/chaos-runner) - [litmuschaos/chaos-exporter](https://cloud.docker.com/u/litmuschaos/repository/docker/litmuschaos/chaos-exporter) -- The chaos chart bundles are created by publishing the github releases for the [chaos-charts](https://github.com/litmuschaos/chaos-charts) repo. This is picked by the chaos [charthub](https://hub.litmuschaos.io) for user download. +- The chaos chart bundles are created by publishing the github releases for the [chaos-charts](https://github.com/litmuschaos/chaos-charts) repo. This is picked by the chaos [charthub](https://hub.litmuschaos.io) for user download. - Tracking of releases is done on Github [project board](https://github.com/litmuschaos/litmus/projects) - 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 + - 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 ### Release Checklist -* [ ] Release branch creation on litmus component repos +* [ ] Release branch creation on litmus component repos * [ ] Release candidate github tags/images created -* [ ] Full e2e pipelines on the release candidates +* [ ] Full e2e pipelines on the release candidates * [ ] Fixes to litmus components based on test results & e2e re-runs * [ ] Cherry-pick commits to release branches & additional RC tags/images * [ ] GA tags/images creation * [ ] Release branch creation on chaos-charts repo, GA image updates & chart GA bundle creation -* [ ] PRs to user artefact/deploy repos: - * [ ] litmuschaos/pages (operator.yaml) +* [ ] PRs to user artefact/deploy repos: + * [ ] litmuschaos/litmus (docs/litmus-operator-.yaml) * [ ] litmuschaos/litmus-helm (litmus infra helm chart) * [ ] litmuschaos/chaos-helm (chaosexperiment bundles) * [ ] Chaos ChartHub Sanity Check * [ ] Sanity e2e runs on GA images -* [ ] Docs sanity & (docusaurus) versioned docs creation +* [ ] Docs sanity & (docusaurus) versioned docs creation * [ ] Release Notes publish * [ ] Updates to Releases & Roadmap artefacts -* [ ] Updates to downstream repos (litmuschaos/litmus-demo) etc., -* [ ] Community Announcements, sync up & contributor shout out! - +* [ ] Updates to downstream repos (litmuschaos/litmus-demo) etc., +* [ ] Community Announcements, sync up & contributor shout out! diff --git a/fossa.md b/fossa.md index 5b7e4ab8b9e..4f48e05d0dd 100644 --- a/fossa.md +++ b/fossa.md @@ -11,5 +11,4 @@ |[Litmus-Docs](https://github.com/litmuschaos/litmus-docs) | No issues reported | |[Community](https://github.com/litmuschaos/community) | No issues reported | |[Test-Tools](https://github.com/litmuschaos/test-tools) | https://app.fossa.com/attribution/5b329bbb-831d-48ec-9ff3-b6f75dab1d4e | -|[Pages](https://github.com/litmuschaos/pages) | No issues reported | |[Website-LitmusChaos](https://github.com/litmuschaos/website-litmuschaos) | No issues reported |