22.\" Title: bash_unit
33.\" Author: [see the "AUTHOR(S)" section]
44.\" Generator: Asciidoctor 2.0.23
5- .\" Date: 2025-01-08
5+ .\" Date: 2025-07-02
66.\" Manual: \ \&
77.\" Source: \ \&
88.\" Language: English
99.\"
10- .TH "BASH_UNIT" "1" "2025-01-08 " "\ \& " "\ \& "
10+ .TH "BASH_UNIT" "1" "2025-07-02 " "\ \& " "\ \& "
1111.ie \n( .g .ds Aq \(aq
1212.el .ds Aq '
1313.ss \n[ .ss ] 0
@@ -38,9 +38,10 @@ bash_unit \- bash unit testing enterprise edition framework for professionals!
3838run them and, in case of failure, displays the stack trace
3939with source file and line number indications to locate the problem.
4040.sp
41- You might want to take a look at \c
42- .URL " getting_started" " how to get started"
43- before continuing reading this documentation.
41+ Need a quick start? The
42+ \c
43+ .URL " https://github.com/bash\- unit/getting_started/" " getting started project"
44+ will help you get on track in no time.
4445.sp
4546The following functions are available in your tests (see below for detailed documentation):
4647.sp
@@ -240,14 +241,14 @@ jobs:
240241 \- uses: actions/checkout@v4
241242 \- name: Unit testing with bash_unit
242243 run: |
243- curl \- s https://raw.githubusercontent.com/bash-unit/bash_unit/master/install.sh | bash
244+ curl \- s https://raw.githubusercontent.com/bash\ - unit/bash_unit/master/install.sh | bash
244245 FORCE_COLOR=true ./bash_unit tests/test_*
245246.fam
246247.fi
247248.if n .RE
248249.sp
249250See this bash_unit \c
250- .URL " https://github.com/pgrange/bash_unit_getting_started" " getting started gitlab project" ""
251+ .URL " https://github.com/pgrange/bash_unit_getting_started" " getting started github project" ""
251252for a working example.
252253.SS "GitLab CI"
253254.sp
@@ -262,7 +263,7 @@ test:
262263 script:
263264 \- apt\- get update
264265 \- apt\- get install \-\- no\- install\- recommends \- y curl ca\- certificates
265- \- curl \- s https://raw.githubusercontent.com/bash-unit/bash_unit/master/install.sh | bash
266+ \- curl \- s https://raw.githubusercontent.com/bash\ - unit/bash_unit/master/install.sh | bash
266267 \- FORCE_COLOR=true ./bash_unit tests/test_*
267268.fam
268269.fi
@@ -283,7 +284,7 @@ Add the following to your pre\-commit configuration. By default it will run scri
283284.nf
284285.fam C
285286repos:
286- \- repo: https://github.com/bash-unit/bash_unit
287+ \- repo: https://github.com/bash\ - unit/bash_unit
287288 rev: v2.2.0
288289 hooks:
289290 \- id: bash\- unit
@@ -495,7 +496,7 @@ your file is a bash script and \fBbash_unit\fP sources it before running your te
495496\fB setup_suite \fP function and avoid any code outside a bash function. you must not use any bash_unit assertion
496497in setup_suite or use exit in setup_suite for teardown_suite to be run.
497498See \c
498- .URL " https://github.com/bash-unit/bash_unit/issues/43" " issue 43" ""
499+ .URL " https://github.com/bash\ - unit/bash_unit/issues/43" " issue 43" ""
499500for more details.
500501.sp
501502If you want to keep an eye on a test not yet implemented, prefix the name of the function by \fB todo \fP instead of test.
0 commit comments