Skip to content

Commit 2d139b4

Browse files
committed
- Change Java toolchain to 21
- Doc edits Signed-off-by: Gopal S Akshintala <[email protected]>
1 parent 27b392d commit 2d139b4

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

README.adoc

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ implementation("com.salesforce.revoman:revoman:{revoman-version}")
6868
----
6969

7070
[.lead]
71-
Minimum Java Version required = 17
71+
Minimum Java Version required = 21
7272

7373
toc::[]
7474

@@ -363,21 +363,21 @@ Here are the environment *key-value* pairs accumulated along the entire executio
363363

364364
image:mutable-env.png[Mutable environment after the execution completion]
365365

366-
[#_granular_failure_reporting]
367-
=== Granular Failure reporting
366+
[#_step_procedure]
367+
=== Step Procedure
368368

369369
[.lead]
370-
During a step execution if something goes wrong (like ) at any of these stages
371-
ReṼoman captures the `Failure` in StepReport:
370+
A Step waterfalls through all these stages and if there is any exception at any stage,
371+
the step procedure fails-fast, and ReṼoman captures the `Failure` in the respective StepReport:
372372

373-
image:step-execution.png[Step Execution]
373+
image:step-procedure.png[Step Procedure]
374374

375375
[NOTE]
376376
====
377377
* `HttpRequestFailure` happens if there is an exception while making the request.It is different from HTTP Error response.
378378
* HTTP Success or Error response is determined by default with HTTP Status Code (SUCCESSFUL: `200 < = statusCode < = 299`).
379-
* HTTP Error response does *NOT* halt the execution by default.
380-
* You can control this behavior using <<_execution_control>>
379+
* HTTP Error response does *NOT* halt the execution of steps by default.
380+
* You can configure this behavior using <<Execution Control>>
381381
====
382382

383383
[.lead]
@@ -389,7 +389,7 @@ image::failure-hierarchy.png[Failure Hierarchy]
389389

390390
[.lead]
391391
ReṼoman logs all the key operations that happen inside its source-code,
392-
including how the environment variables are being mutated by a step in its <<Pre-req and Post-res scripts>>.
392+
including how a step mutates environment variables in its <<Pre-req and Post-res scripts>>.
393393
Watch your console to check what's going on in the execution or troubleshoot from CI/CD logs
394394

395395
TIP: link:docs/revoman.exe.log[📝Sample log] printed during execution
@@ -477,13 +477,13 @@ See in Action:
477477
[#_execution_control]
478478
=== Execution Control
479479

480-
If an exception is thrown during the execution of any step,
481-
the execution *fails fast for that step*,
482-
and captures the exception as a <<_granular_failure_reporting,Failure>> in the StepReport.
483-
However, the execution of next steps may or may not halt, depending on the below Configuration options:
480+
If an exception is thrown during the procedure of any step,
481+
the <<Step Procedure>> *fails fast for that step*.
482+
However, the execution of next steps won't halt by default.
483+
You can configure this behavior to *fail-fast* using the below Configuration options:
484484

485-
* `haltOnAnyFailure` — This defaults to `false`. If set to `true`, the execution of steps fails-fast when it encounters a failure.
486-
* `haltOnFailureOfTypeExcept` — This accepts pairs of `ExeType` and a `PostTxnStepPick` which are used to check if a Step can be ignored for failure for a specific failure type or halt the execution of next steps
485+
* `haltOnAnyFailure` — This defaults to `false`. If set to `true`, the execution of steps fails-fast when it encounters a failure. This also halts if there is a HTTP error response
486+
* `haltOnFailureOfTypeExcept` — You may configure to Fail-fast only for a specific Failure type by providing an `ExeType`. Along with it, you may provide a `PostTxnStepPick` which is used to check if a Step can be ignored for that specific failure type or halt the execution of next steps
487487

488488
These Configuration options, as their names suggest,
489489
let you conditionally run or skip steps in a chain of steps from the template, without the need to change the template.
File renamed without changes.

libs.versions.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[versions]
2-
jdk = "17"
2+
jdk = "21"
33
kotlin = "2.1.10"
44
moshix = "0.29.0"
55
http4k = "6.0.1.0"

0 commit comments

Comments
 (0)