Skip to content

Commit f40bbec

Browse files
committed
docs: run documentation generator
Signed-off-by: Jack Wilsdon <jack+github@wilsdon.me>
1 parent 9a2b17e commit f40bbec

8 files changed

Lines changed: 14 additions & 14 deletions

File tree

docs/pages/configuration/_partials/functions/group_checks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
import PartialIstrue from "./is_true.mdx"
66
import PartialIsos from "./is_os.mdx"
7+
import PartialIsin from "./is_in.mdx"
78
import PartialIsequal from "./is_equal.mdx"
89
import PartialIsempty from "./is_empty.mdx"
910
import PartialIsdependency from "./is_dependency.mdx"
10-
import PartialIsin from "./is_in.mdx"
1111

1212
<PartialIsdependency />
1313
<PartialIsempty />

docs/pages/configuration/_partials/functions/group_checks_global.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44

55
import PartialIstrue from "./is_true.mdx"
66
import PartialIsos from "./is_os.mdx"
7+
import PartialIsin from "./is_in.mdx"
78
import PartialIsequal from "./is_equal.mdx"
89
import PartialIsempty from "./is_empty.mdx"
910
import PartialIsdependency from "./is_dependency.mdx"
10-
import PartialIsin from "./is_in.mdx"
1111

1212
<PartialIsdependency />
1313
<PartialIsempty />

docs/pages/configuration/_partials/functions/is_dependency.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<details className="config-field -function" data-expandable="false">
44
<summary>
55

6-
### `is_dependency` <span className="config-field-type"></span> <span className="config-field-enum"></span> <span className="config-field-default -return">bool</span> <span className="config-field-required" data-required="false">pipeline only</span> {#is_dependency}
6+
### `is_dependency` <span className="config-field-type"></span> <span className="config-field-enum"></span> <span className="config-field-default -return">int</span> <span className="config-field-required" data-required="false">pipeline only</span> {#is_dependency}
77

8-
Returns true if the pipeline currently being executed is run because the project is a dependency of another project
8+
Returns exit code 0 if the pipeline currently being executed is run because the project is a dependency of another project
99

1010
</summary>
1111

docs/pages/configuration/_partials/functions/is_empty.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<details className="config-field -function" data-expandable="false">
44
<summary>
55

6-
### `is_empty` <span className="config-field-type">[value]</span> <span className="config-field-enum"></span> <span className="config-field-default -return">bool</span> <span className="config-field-required" data-required="false">pipeline only</span> {#is_empty}
6+
### `is_empty` <span className="config-field-type">[value]</span> <span className="config-field-enum"></span> <span className="config-field-default -return">int</span> <span className="config-field-required" data-required="false">pipeline only</span> {#is_empty}
77

8-
Returns true if the value of the argument is empty string
8+
Returns exit code 0 if the value of the argument is empty string
99

1010
</summary>
1111

docs/pages/configuration/_partials/functions/is_equal.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<details className="config-field -function" data-expandable="false">
44
<summary>
55

6-
### `is_equal` <span className="config-field-type">[value-1] [value-2]</span> <span className="config-field-enum"></span> <span className="config-field-default -return">bool</span> <span className="config-field-required" data-required="false">pipeline only</span> {#is_equal}
6+
### `is_equal` <span className="config-field-type">[value-1] [value-2]</span> <span className="config-field-enum"></span> <span className="config-field-default -return">int</span> <span className="config-field-required" data-required="false">pipeline only</span> {#is_equal}
77

8-
Returns true if the values of both arguments provided are equal
8+
Returns exit code 0 if the values of both arguments provided are equal
99

1010
</summary>
1111

docs/pages/configuration/_partials/functions/is_in.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<details className="config-field -function" data-expandable="false">
44
<summary>
55

6-
### `is_in` <span className="config-field-type">[value-1] [value-2]</span> <span className="config-field-enum"></span> <span className="config-field-default -return">bool</span> <span className="config-field-required" data-required="false">pipeline only</span> {#is_in}
6+
### `is_in` <span className="config-field-type">[value-1] [value-2]</span> <span className="config-field-enum"></span> <span className="config-field-default -return">int</span> <span className="config-field-required" data-required="false">pipeline only</span> {#is_in}
77

8-
Returns true if value of the first argument can be found in the second argument (second argument beeing a blank-separated list of strings e.g `"bananas apples peaches"`)
8+
Returns exit code 0 if the value of the first argument can be found in the second argument (second argument being a blank-separated list of strings e.g `"bananas apples peaches"`)
99

1010
</summary>
1111

docs/pages/configuration/_partials/functions/is_os.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<details className="config-field -function" data-expandable="false">
44
<summary>
55

6-
### `is_os` <span className="config-field-type">[os]</span> <span className="config-field-enum"><span>darwin linux windows aix android dragonfly freebsd hurd illumos ios js nacl netbsd openbsd plan9 solaris zos</span></span> <span className="config-field-default -return">bool</span> <span className="config-field-required" data-required="false">pipeline only</span> {#is_os}
6+
### `is_os` <span className="config-field-type">[os]</span> <span className="config-field-enum"><span>darwin linux windows aix android dragonfly freebsd hurd illumos ios js nacl netbsd openbsd plan9 solaris zos</span></span> <span className="config-field-default -return">int</span> <span className="config-field-required" data-required="false">pipeline only</span> {#is_os}
77

8-
Returns true if the current operating system equals the value provided as argument
8+
Returns exit code 0 if the current operating system equals the value provided as argument
99

1010
</summary>
1111

docs/pages/configuration/_partials/functions/is_true.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
<details className="config-field -function" data-expandable="false">
44
<summary>
55

6-
### `is_true` <span className="config-field-type">[value]</span> <span className="config-field-enum"></span> <span className="config-field-default -return">bool</span> <span className="config-field-required" data-required="false">pipeline only</span> {#is_true}
6+
### `is_true` <span className="config-field-type">[value]</span> <span className="config-field-enum"></span> <span className="config-field-default -return">int</span> <span className="config-field-required" data-required="false">pipeline only</span> {#is_true}
77

8-
Returns true if the value of the argument is "true"
8+
Returns exit code 0 if the value of the argument is "true"
99

1010
</summary>
1111

0 commit comments

Comments
 (0)