2
2
.\" Title: bash_unit
3
3
.\" Author: [see the "AUTHOR(S)" section]
4
4
.\" Generator: Asciidoctor 2.0.23
5
- .\" Date: 2025-01-08
5
+ .\" Date: 2025-07-02
6
6
.\" Manual: \ \&
7
7
.\" Source: \ \&
8
8
.\" Language: English
9
9
.\"
10
- .TH "BASH_UNIT" "1" "2025-01-08 " "\ \& " "\ \& "
10
+ .TH "BASH_UNIT" "1" "2025-07-02 " "\ \& " "\ \& "
11
11
.ie \n( .g .ds Aq \(aq
12
12
.el .ds Aq '
13
13
.ss \n[ .ss ] 0
@@ -38,9 +38,10 @@ bash_unit \- bash unit testing enterprise edition framework for professionals!
38
38
run them and, in case of failure, displays the stack trace
39
39
with source file and line number indications to locate the problem.
40
40
.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.
44
45
.sp
45
46
The following functions are available in your tests (see below for detailed documentation):
46
47
.sp
@@ -240,14 +241,14 @@ jobs:
240
241
\- uses: actions/checkout@v4
241
242
\- name: Unit testing with bash_unit
242
243
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
244
245
FORCE_COLOR=true ./bash_unit tests/test_*
245
246
.fam
246
247
.fi
247
248
.if n .RE
248
249
.sp
249
250
See 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" ""
251
252
for a working example.
252
253
.SS "GitLab CI"
253
254
.sp
@@ -262,7 +263,7 @@ test:
262
263
script:
263
264
\- apt\- get update
264
265
\- 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
266
267
\- FORCE_COLOR=true ./bash_unit tests/test_*
267
268
.fam
268
269
.fi
@@ -283,7 +284,7 @@ Add the following to your pre\-commit configuration. By default it will run scri
283
284
.nf
284
285
.fam C
285
286
repos:
286
- \- repo: https://github.com/bash-unit/bash_unit
287
+ \- repo: https://github.com/bash\ - unit/bash_unit
287
288
rev: v2.2.0
288
289
hooks:
289
290
\- id: bash\- unit
@@ -495,7 +496,7 @@ your file is a bash script and \fBbash_unit\fP sources it before running your te
495
496
\fB setup_suite \fP function and avoid any code outside a bash function. you must not use any bash_unit assertion
496
497
in setup_suite or use exit in setup_suite for teardown_suite to be run.
497
498
See \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" ""
499
500
for more details.
500
501
.sp
501
502
If 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