From 601ca194af29bdfb71747c04cbb25e926f5421d3 Mon Sep 17 00:00:00 2001 From: John Ky Date: Fri, 9 Jun 2023 07:18:50 +1000 Subject: [PATCH 1/2] Add explanation and 'Incidents' section to cardano-node-required-checks page --- docs/Cardano-node-required-checks.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/docs/Cardano-node-required-checks.md b/docs/Cardano-node-required-checks.md index 7ca25f7..a6c219e 100644 --- a/docs/Cardano-node-required-checks.md +++ b/docs/Cardano-node-required-checks.md @@ -2,13 +2,25 @@ These are the agreed-upon required checks for the [`cardano-node` repository](https://github.com/input-output-hk/cardano-node). -Legend: +Whenever there is a variation to this document, the required checks for the `cardano-node` +repository should be updated accordingly. + +If the required checks for the `cardano-node` repository are found to differ from those +described here, then those should be updated to match this page. + +Sometimes, due to an urgent situation, a required-check may need to be disabled +to merge an important PR. Those incidents should be documented in the incidents +section of the page. Keeping a list of such incidents will help us understand +which require-checks are problematic. + +### Legend * ✅ Required check. Merges disallowed unless this job is successful. * 👉 Pre-requisite required check. A required check depends on this job. A job with a required check could not pass without this passing. * ⛔ No required check and not a pre-requisite. +### Required Checks * ⛔ Check Markdown links / markdown-link-check (push) * ⛔ Check HLint / build (push) * ⛔ Check Stylish Haskell / build (push) @@ -45,3 +57,7 @@ Legend: * ⛔ ci/eval * ✅ ci/hydra-build:required * ⛔ ci/pr/required + +### Incidents + +List emergency incidents here. From 1e79964dfa271cf2e3e66d723f553810152f29c1 Mon Sep 17 00:00:00 2001 From: olgahryniuk <67585499+olgahryniuk@users.noreply.github.com> Date: Fri, 9 Jun 2023 09:31:28 +0300 Subject: [PATCH 2/2] Minor edits --- docs/Cardano-node-required-checks.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/Cardano-node-required-checks.md b/docs/Cardano-node-required-checks.md index a6c219e..7fbe5f4 100644 --- a/docs/Cardano-node-required-checks.md +++ b/docs/Cardano-node-required-checks.md @@ -5,13 +5,13 @@ These are the agreed-upon required checks for the [`cardano-node` repository](ht Whenever there is a variation to this document, the required checks for the `cardano-node` repository should be updated accordingly. -If the required checks for the `cardano-node` repository are found to differ from those +If the required checks for the `cardano-node` repository differ from those described here, then those should be updated to match this page. -Sometimes, due to an urgent situation, a required-check may need to be disabled -to merge an important PR. Those incidents should be documented in the incidents -section of the page. Keeping a list of such incidents will help us understand -which require-checks are problematic. +Sometimes, due to an urgent situation, a required check may need to be disabled +to merge an important PR. Those incidents should be documented in the incidents +section of the page. Keeping a list of such incidents will help us understand +which required checks are problematic. ### Legend * ✅ Required check.