bashutils/README.md

30 lines
653 B
Markdown
Raw Normal View History

2024-10-26 22:54:26 +02:00
# bashutils
Provides some nice utility methods for bash scripts.
## Features
- SOSLS v2-compliant logging
- various check methods
- easy variable definition
## Documentation
See [bashutils.staropensource.de](https://bashutils.staropensource.de)
2024-10-27 13:30:17 +01:00
## Testing
You run bashutils' tests by invoking the `test.sh` script.
The test script accepts environment variables as configuration.
### Configuration
2024-10-27 13:32:51 +01:00
<table>
<tr>
<td>VARIABLE</td>
<td>TYPE</td>
<td>DEFAULT</td>
<td>DESCRIPTION</td>
</tr>
<tr>
<td><code>FAILFAST</code></td>
2024-10-27 13:33:18 +01:00
<td><code>bool</code></td>
2024-10-27 13:32:51 +01:00
<td><code>false</code></td>
<td>Terminates if a test fails instead of continuing</td>
</tr>
</table>