674 Add possibility to run different TCR variants

README.md

@@ -90,6 +90,16 @@ provided as built-in.
 | scala      | sbt               | sbt                                                  |
 | typescript | yarn              | yarn bazel make                                      |
 
+### TCR Variants
+
+TCR tool can run several variants of the TCR workflow, inspired by [this blog post](https://medium.com/@tdeniffel/tcr-variants-test-commit-revert-bf6bd84b17d3)
+by Thomas Deniffel.
+
+Some are great as pedagogic tools, some are better for day-to-day use.
+
+The default variant is "The Relaxed". You can refer to [this page](./variants-doc/tcr_variants.md)
+for further details on available variants.
+
 ### Base directory
 
 In order to know which files and directories to watch, TCR needs to know on which part of the filesystem it should work.

doc/tcr.md

@@ -18,7 +18,7 @@ tcr [flags]
 ```
   -p, --auto-push               enable VCS push after every commit
   -b, --base-dir string         indicate the directory from which TCR is looking for files (default: current directory)
-  -f, --commit-failures         enable committing reverts on tests failure
+  -F, --commit-failures         enable committing reverts on tests failure
   -c, --config-dir string       indicate the directory where TCR configuration is stored (default: current directory)
   -d, --duration duration       set the duration for role rotation countdown timer
   -h, --help                    help for tcr
@@ -28,6 +28,7 @@ tcr [flags]
   -P, --port-number int         indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
   -t, --toolchain string        indicate the toolchain to be used by TCR
   -T, --trace string            indicate trace options. Recognized values: none (default), vcs or http
+  -r, --variant string          indicate the variant to be used by TCR: nice (default) or original
   -V, --vcs string              indicate the VCS (version control system) to be used by TCR: git (default) or p4
   -w, --work-dir string         indicate the directory from which TCR is running (default: current directory)
 ```

doc/tcr_check.md

@@ -46,7 +46,7 @@ tcr check [flags]
 ```
   -p, --auto-push               enable VCS push after every commit
   -b, --base-dir string         indicate the directory from which TCR is looking for files (default: current directory)
-  -f, --commit-failures         enable committing reverts on tests failure
+  -F, --commit-failures         enable committing reverts on tests failure
   -c, --config-dir string       indicate the directory where TCR configuration is stored (default: current directory)
   -d, --duration duration       set the duration for role rotation countdown timer
   -l, --language string         indicate the programming language to be used by TCR
@@ -55,6 +55,7 @@ tcr check [flags]
   -P, --port-number int         indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
   -t, --toolchain string        indicate the toolchain to be used by TCR
   -T, --trace string            indicate trace options. Recognized values: none (default), vcs or http
+  -r, --variant string          indicate the variant to be used by TCR: nice (default) or original
   -V, --vcs string              indicate the VCS (version control system) to be used by TCR: git (default) or p4
   -w, --work-dir string         indicate the directory from which TCR is running (default: current directory)
 ```

doc/tcr_config.md

@@ -24,7 +24,7 @@ tcr config [flags]
 ```
   -p, --auto-push               enable VCS push after every commit
   -b, --base-dir string         indicate the directory from which TCR is looking for files (default: current directory)
-  -f, --commit-failures         enable committing reverts on tests failure
+  -F, --commit-failures         enable committing reverts on tests failure
   -c, --config-dir string       indicate the directory where TCR configuration is stored (default: current directory)
   -d, --duration duration       set the duration for role rotation countdown timer
   -l, --language string         indicate the programming language to be used by TCR
@@ -33,6 +33,7 @@ tcr config [flags]
   -P, --port-number int         indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
   -t, --toolchain string        indicate the toolchain to be used by TCR
   -T, --trace string            indicate trace options. Recognized values: none (default), vcs or http
+  -r, --variant string          indicate the variant to be used by TCR: nice (default) or original
   -V, --vcs string              indicate the VCS (version control system) to be used by TCR: git (default) or p4
   -w, --work-dir string         indicate the directory from which TCR is running (default: current directory)
 ```

doc/tcr_config_reset.md

@@ -24,7 +24,7 @@ tcr config reset [flags]
 ```
   -p, --auto-push               enable VCS push after every commit
   -b, --base-dir string         indicate the directory from which TCR is looking for files (default: current directory)
-  -f, --commit-failures         enable committing reverts on tests failure
+  -F, --commit-failures         enable committing reverts on tests failure
   -c, --config-dir string       indicate the directory where TCR configuration is stored (default: current directory)
   -d, --duration duration       set the duration for role rotation countdown timer
   -l, --language string         indicate the programming language to be used by TCR
@@ -33,6 +33,7 @@ tcr config reset [flags]
   -P, --port-number int         indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
   -t, --toolchain string        indicate the toolchain to be used by TCR
   -T, --trace string            indicate trace options. Recognized values: none (default), vcs or http
+  -r, --variant string          indicate the variant to be used by TCR: nice (default) or original
   -V, --vcs string              indicate the VCS (version control system) to be used by TCR: git (default) or p4
   -w, --work-dir string         indicate the directory from which TCR is running (default: current directory)
 ```

doc/tcr_config_save.md

@@ -24,7 +24,7 @@ tcr config save [flags]
 ```
   -p, --auto-push               enable VCS push after every commit
   -b, --base-dir string         indicate the directory from which TCR is looking for files (default: current directory)
-  -f, --commit-failures         enable committing reverts on tests failure
+  -F, --commit-failures         enable committing reverts on tests failure
   -c, --config-dir string       indicate the directory where TCR configuration is stored (default: current directory)
   -d, --duration duration       set the duration for role rotation countdown timer
   -l, --language string         indicate the programming language to be used by TCR
@@ -33,6 +33,7 @@ tcr config save [flags]
   -P, --port-number int         indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
   -t, --toolchain string        indicate the toolchain to be used by TCR
   -T, --trace string            indicate trace options. Recognized values: none (default), vcs or http
+  -r, --variant string          indicate the variant to be used by TCR: nice (default) or original
   -V, --vcs string              indicate the VCS (version control system) to be used by TCR: git (default) or p4
   -w, --work-dir string         indicate the directory from which TCR is running (default: current directory)
 ```

doc/tcr_config_show.md

@@ -24,7 +24,7 @@ tcr config show [flags]
 ```
   -p, --auto-push               enable VCS push after every commit
   -b, --base-dir string         indicate the directory from which TCR is looking for files (default: current directory)
-  -f, --commit-failures         enable committing reverts on tests failure
+  -F, --commit-failures         enable committing reverts on tests failure
   -c, --config-dir string       indicate the directory where TCR configuration is stored (default: current directory)
   -d, --duration duration       set the duration for role rotation countdown timer
   -l, --language string         indicate the programming language to be used by TCR
@@ -33,6 +33,7 @@ tcr config show [flags]
   -P, --port-number int         indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
   -t, --toolchain string        indicate the toolchain to be used by TCR
   -T, --trace string            indicate trace options. Recognized values: none (default), vcs or http
+  -r, --variant string          indicate the variant to be used by TCR: nice (default) or original
   -V, --vcs string              indicate the VCS (version control system) to be used by TCR: git (default) or p4
   -w, --work-dir string         indicate the directory from which TCR is running (default: current directory)
 ```

doc/tcr_info.md

@@ -24,7 +24,7 @@ tcr info [flags]
 ```
   -p, --auto-push               enable VCS push after every commit
   -b, --base-dir string         indicate the directory from which TCR is looking for files (default: current directory)
-  -f, --commit-failures         enable committing reverts on tests failure
+  -F, --commit-failures         enable committing reverts on tests failure
   -c, --config-dir string       indicate the directory where TCR configuration is stored (default: current directory)
   -d, --duration duration       set the duration for role rotation countdown timer
   -l, --language string         indicate the programming language to be used by TCR
@@ -33,6 +33,7 @@ tcr info [flags]
   -P, --port-number int         indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
   -t, --toolchain string        indicate the toolchain to be used by TCR
   -T, --trace string            indicate trace options. Recognized values: none (default), vcs or http
+  -r, --variant string          indicate the variant to be used by TCR: nice (default) or original
   -V, --vcs string              indicate the VCS (version control system) to be used by TCR: git (default) or p4
   -w, --work-dir string         indicate the directory from which TCR is running (default: current directory)
 ```

doc/tcr_log.md

@@ -32,7 +32,7 @@ tcr log [flags]
 ```
   -p, --auto-push               enable VCS push after every commit
   -b, --base-dir string         indicate the directory from which TCR is looking for files (default: current directory)
-  -f, --commit-failures         enable committing reverts on tests failure
+  -F, --commit-failures         enable committing reverts on tests failure
   -c, --config-dir string       indicate the directory where TCR configuration is stored (default: current directory)
   -d, --duration duration       set the duration for role rotation countdown timer
   -l, --language string         indicate the programming language to be used by TCR
@@ -41,6 +41,7 @@ tcr log [flags]
   -P, --port-number int         indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
   -t, --toolchain string        indicate the toolchain to be used by TCR
   -T, --trace string            indicate trace options. Recognized values: none (default), vcs or http
+  -r, --variant string          indicate the variant to be used by TCR: nice (default) or original
   -V, --vcs string              indicate the VCS (version control system) to be used by TCR: git (default) or p4
   -w, --work-dir string         indicate the directory from which TCR is running (default: current directory)
 ```

doc/tcr_mob.md

@@ -24,7 +24,7 @@ tcr mob [flags]
 ```
   -p, --auto-push               enable VCS push after every commit
   -b, --base-dir string         indicate the directory from which TCR is looking for files (default: current directory)
-  -f, --commit-failures         enable committing reverts on tests failure
+  -F, --commit-failures         enable committing reverts on tests failure
   -c, --config-dir string       indicate the directory where TCR configuration is stored (default: current directory)
   -d, --duration duration       set the duration for role rotation countdown timer
   -l, --language string         indicate the programming language to be used by TCR
@@ -33,6 +33,7 @@ tcr mob [flags]
   -P, --port-number int         indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
   -t, --toolchain string        indicate the toolchain to be used by TCR
   -T, --trace string            indicate trace options. Recognized values: none (default), vcs or http
+  -r, --variant string          indicate the variant to be used by TCR: nice (default) or original
   -V, --vcs string              indicate the VCS (version control system) to be used by TCR: git (default) or p4
   -w, --work-dir string         indicate the directory from which TCR is running (default: current directory)
 ```

doc/tcr_one-shot.md

@@ -35,7 +35,7 @@ tcr one-shot [flags]
 ```
   -p, --auto-push               enable VCS push after every commit
   -b, --base-dir string         indicate the directory from which TCR is looking for files (default: current directory)
-  -f, --commit-failures         enable committing reverts on tests failure
+  -F, --commit-failures         enable committing reverts on tests failure
   -c, --config-dir string       indicate the directory where TCR configuration is stored (default: current directory)
   -d, --duration duration       set the duration for role rotation countdown timer
   -l, --language string         indicate the programming language to be used by TCR
@@ -44,6 +44,7 @@ tcr one-shot [flags]
   -P, --port-number int         indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
   -t, --toolchain string        indicate the toolchain to be used by TCR
   -T, --trace string            indicate trace options. Recognized values: none (default), vcs or http
+  -r, --variant string          indicate the variant to be used by TCR: nice (default) or original
   -V, --vcs string              indicate the VCS (version control system) to be used by TCR: git (default) or p4
   -w, --work-dir string         indicate the directory from which TCR is running (default: current directory)
 ```

doc/tcr_solo.md

@@ -24,7 +24,7 @@ tcr solo [flags]
 ```
   -p, --auto-push               enable VCS push after every commit
   -b, --base-dir string         indicate the directory from which TCR is looking for files (default: current directory)
-  -f, --commit-failures         enable committing reverts on tests failure
+  -F, --commit-failures         enable committing reverts on tests failure
   -c, --config-dir string       indicate the directory where TCR configuration is stored (default: current directory)
   -d, --duration duration       set the duration for role rotation countdown timer
   -l, --language string         indicate the programming language to be used by TCR
@@ -33,6 +33,7 @@ tcr solo [flags]
   -P, --port-number int         indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
   -t, --toolchain string        indicate the toolchain to be used by TCR
   -T, --trace string            indicate trace options. Recognized values: none (default), vcs or http
+  -r, --variant string          indicate the variant to be used by TCR: nice (default) or original
   -V, --vcs string              indicate the VCS (version control system) to be used by TCR: git (default) or p4
   -w, --work-dir string         indicate the directory from which TCR is running (default: current directory)
 ```

doc/tcr_stats.md

@@ -52,7 +52,7 @@ tcr stats [flags]
 ```
   -p, --auto-push               enable VCS push after every commit
   -b, --base-dir string         indicate the directory from which TCR is looking for files (default: current directory)
-  -f, --commit-failures         enable committing reverts on tests failure
+  -F, --commit-failures         enable committing reverts on tests failure
   -c, --config-dir string       indicate the directory where TCR configuration is stored (default: current directory)
   -d, --duration duration       set the duration for role rotation countdown timer
   -l, --language string         indicate the programming language to be used by TCR
@@ -61,6 +61,7 @@ tcr stats [flags]
   -P, --port-number int         indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
   -t, --toolchain string        indicate the toolchain to be used by TCR
   -T, --trace string            indicate trace options. Recognized values: none (default), vcs or http
+  -r, --variant string          indicate the variant to be used by TCR: nice (default) or original
   -V, --vcs string              indicate the VCS (version control system) to be used by TCR: git (default) or p4
   -w, --work-dir string         indicate the directory from which TCR is running (default: current directory)
 ```

doc/tcr_web.md

@@ -30,7 +30,7 @@ tcr web [flags]
 ```
   -p, --auto-push               enable VCS push after every commit
   -b, --base-dir string         indicate the directory from which TCR is looking for files (default: current directory)
-  -f, --commit-failures         enable committing reverts on tests failure
+  -F, --commit-failures         enable committing reverts on tests failure
   -c, --config-dir string       indicate the directory where TCR configuration is stored (default: current directory)
   -d, --duration duration       set the duration for role rotation countdown timer
   -l, --language string         indicate the programming language to be used by TCR
@@ -39,6 +39,7 @@ tcr web [flags]
   -P, --port-number int         indicate port number used by TCR HTTP server in web mode (experimental) (default: 8483)
   -t, --toolchain string        indicate the toolchain to be used by TCR
   -T, --trace string            indicate trace options. Recognized values: none (default), vcs or http
+  -r, --variant string          indicate the variant to be used by TCR: nice (default) or original
   -V, --vcs string              indicate the VCS (version control system) to be used by TCR: git (default) or p4
   -w, --work-dir string         indicate the directory from which TCR is running (default: current directory)
 ```