From 5a39f72aa8288696d7284e56e3f630ab721a9f9a Mon Sep 17 00:00:00 2001
From: Anton Kaliaev <anton.kalyaev@gmail.com>
Date: Mon, 22 Feb 2021 11:19:47 +0400
Subject: [PATCH] .github: [jepsen] add more docs (#6141)

---
 .github/workflows/jepsen.yml | 24 +++++++++++++++++-------
 1 file changed, 17 insertions(+), 7 deletions(-)

diff --git a/.github/workflows/jepsen.yml b/.github/workflows/jepsen.yml
index 720dfdefc..347181dd2 100644
--- a/.github/workflows/jepsen.yml
+++ b/.github/workflows/jepsen.yml
@@ -1,10 +1,19 @@
-# Runs Jepsen tests: https://github.com/tendermint/jepsen.
+# Runs a Jepsen test - cas-register (no nemesis) by default.
+#   See inputs for various options.
+#   Repo: https://github.com/tendermint/jepsen
+#
+# If you want to test a new breaking version of Tendermint, you'll need to
+# update the Merkleeyes ABCI app and 'merkleeyesUrl' input accordingly. You can
+# upload a new tarball to
+# https://github.com/tendermint/jepsen/releases/tag/0.2.1.
+#
+# Manually triggered.
 name: jepsen
 on:
   workflow_dispatch:
     inputs:
       workload:
-        description: 'Test workload to run; e.g. cas-register, set'
+        description: 'Test workload to run: (cas-register | set)'
         required: true
         default: 'cas-register'
       nemesis:
@@ -24,23 +33,24 @@ on:
         required: true
         default: 60
       tendermintUrl:
-        description: 'Where to grab the Tendermint binary (linux/amd64 tarball)?'
+        description: 'Where to grab the Tendermint tarball (w/ linux/amd64 binary)'
         required: true
         default: 'https://github.com/melekes/katas/releases/download/0.2.0/tendermint.tar.gz'
       merkleeyesUrl:
-        description: 'Where to grab the Merkleeyes binary (linux/amd64 tarball)?'
+        description: 'Where to grab the Merkleeyes tarball (w/ linux/amd64 binary)'
         required: true
-        default: 'https://github.com/melekes/katas/releases/download/0.2.0/merkleeyes_0.1.7.tar.gz'
+        default: 'https://github.com/tendermint/jepsen/releases/download/0.2.1/merkleeyes_0.1.7.tar.gz'
 
 jobs:
   jepsen-test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout the Jepsen repository
+        uses: actions/checkout@v2
         with:
           repository: 'tendermint/jepsen'
 
-      - name: Start a Jepsen cluster
+      - name: Start a Jepsen cluster in background
         working-directory: docker
         run: ./bin/up --daemon