Skip to content

Commit 169775c

Browse files
committed
Updated README for additional refinements
1 parent 7d6140f commit 169775c

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

+6-7
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,7 @@ Maven Version Checker is a GitHub action that checks for any available updates f
1818
* Summary reports are generated after each run.
1919
* Supports being ran locally or from another third-party pipeline.
2020
* Implements standard resilience strategies like retry, circuit breaker, etc.
21-
* Implements chaos strategies to test the resiliency of the application during development.
22-
* Centralizes control of chaos strategies via the Chaos Manager.
21+
* Implements chaos strategies to test the resiliency of the application.
2322

2423
## Compatibility
2524
Below is a list of GitHub-hosted runners that support jobs using this action.
@@ -121,7 +120,10 @@ docker run --name maven-version-checker --workdir=/data --rm \
121120

122121
If all goes well, the `summary.txt` and `output.txt` files will be updated so that they can be leveraged for further processing.
123122

124-
Alternatively, compile the code for the target OS using a matching [Runtime Identifier (RID)](https://learn.microsoft.com/en-us/dotnet/core/rid-catalog#known-rids), and run directly from the command line using the following:
123+
> [!IMPORTANT]
124+
> When running outside of GitHub, ensure that the `summary.txt` and `output.txt` files exist or are created before running the application.
125+
126+
Alternatively, compile the code for the target system using a matching [Runtime Identifier (RID)](https://learn.microsoft.com/en-us/dotnet/core/rid-catalog#known-rids) as in one of the command line examples below. The [.NET 8 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) also needs to be installed in order to compile the code, which may be already included as part of the needed AOT [Prerequisites](https://learn.microsoft.com/en-us/dotnet/core/deploying/native-aot/?tabs=windows%2Cnet8#prerequisites) for the target system.
125127

126128
**Linux**
127129

@@ -168,11 +170,8 @@ export GITHUB_OUTPUT="./Locals/output.txt"
168170
./MavenVersionChecker.Action
169171
```
170172

171-
> [!IMPORTANT]
172-
> When running locally, ensure that the `summary.txt` and `output.txt` files exist or are created before running the application. The [.NET 8 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0) also needs to be installed in order to compile the code, which may be already included as part of the needed [Prerequisites](https://learn.microsoft.com/en-us/dotnet/core/deploying/native-aot/?tabs=windows%2Cnet8#prerequisites).
173-
174173
## Enabling the chaos strategies
175-
To enable the chaos strategies, set an environment variable called `ASPNETCORE_ENVIRONMENT` to `Chaos` and restart the application. If using Visual Studio or another compatible IDE, select the `ChaosConsole (Multi)` profile before running the code. Supported chaos strategies include ChaosFault, ChaosLatency, and ChaosOutcome to test the standard resilience strategies being used and the business logic around it. Below is a summary of their purposes.
174+
To enable the chaos strategies, set an environment variable called `ASPNETCORE_ENVIRONMENT` to `Chaos` and restart the application. If using Visual Studio or another compatible IDE, select the `ChaosConsole (Multi)` profile before running the code. The table below shows the supported chaos strategies being used to test the standard resilience strategies and the business logic around it.
176175

177176
|Strategy | Type | What does the strategy do? |
178177
|:--------|:----------|:---------------------------------------------------------------|

0 commit comments

Comments
 (0)