Skip to content

Commit 6a9a3bb

Browse files
apaleslimghostapaleslimghost
committed
docs: automatically regenerate schema docs
1 parent 370db68 commit 6a9a3bb

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

‎plugins/circleci/readme.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,13 @@ Options provided in your repository's `.toolkitrc.yml` for this hook are merged
3737
Unless they conflict, your options are appended to options from plugins, allowing you to define custom CircleCI jobs and workflows in your repository that work alongside those from plugins.
3838
#### Hook options
3939

40-
| Property | Description | Type |
41-
| :------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
42-
| `executors` | an array of additional CircleCI executors to output in the generated config. | _Array of objects:_<br /><ul><li>`name`: `string`</li><li>`image`: `string`</li></ul> |
43-
| `jobs` | an array of additional CircleCI jobs to output in the generated config. these are used for running Tool Kit commands. for running arbitrary shell commands, use `custom`. | _Array of objects:_<br /><ul><li>`name`: `string`</li><li>`command`: `string`</li><li>`workspace`: _Object with properties:_<ul><li>`persist`: `boolean`</li><li>`attach`: `boolean`</li></ul></li><li>`steps`: _Object with properties:_<ul><li>`pre`: `Array<string _or_ _Object with dynamic keys of type_ string _and values of type_ _Object with dynamic keys of type_ string _and values of type_ unknown (_optional & nullable_)>`</li><li>`post`: `Array<string _or_ _Object with dynamic keys of type_ string _and values of type_ _Object with dynamic keys of type_ string _and values of type_ unknown (_optional & nullable_)>`</li></ul></li><li>`splitIntoMatrix`: `boolean`</li><li>`custom`: _Object with dynamic keys of type_ `string` _and values of type_ `unknown` (_optional & nullable_)</li></ul> |
44-
| `workflows` | an array of additional CircleCI workflows to output in the generated config. these reference jobs defined in the `jobs` option. | _Array of objects:_<br /><ul><li>`name`: `string`</li><li>`jobs`: _Array of objects:_<br /><ul><li>`name`: `string`</li><li>`requires`: `Array<string>`</li><li>`splitIntoMatrix`: `boolean`</li><li>`runOnRelease`: `boolean`</li><li>`custom`: _Object with dynamic keys of type_ `string` _and values of type_ `unknown` (_optional & nullable_)</li></ul></li><li>`runOnRelease`: `boolean`</li><li>`custom`: _Object with dynamic keys of type_ `string` _and values of type_ `unknown` (_optional & nullable_)</li></ul> |
45-
| `custom` | arbitrary additional CircleCI configuration that will be merged into the Tool Kit-generated config. | _Object with dynamic keys of type_ `string` _and values of type_ `unknown` (_optional & nullable_) |
46-
| `disableBaseConfig` | set to `true` to omit the Tool Kit CircleCI boilerplate. should be used along with `custom` to provide your own boilerplate. | `boolean` |
40+
| Property | Description | Type |
41+
| :------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
42+
| `executors` | an array of additional CircleCI executors to output in the generated config. | _Array of objects:_<br /><ul><li>`name`: `string`</li><li>`image`: `string`</li></ul> |
43+
| `jobs` | an array of additional CircleCI jobs to output in the generated config. these are used for running Tool Kit commands. for running arbitrary shell commands, use `custom`. | _Array of objects:_<br /><ul><li>`name`: `string`</li><li>`command`: `string`</li><li>`workspace`: _Object with properties:_<ul><li>`persist`: `boolean \| Array<string>`</li><li>`attach`: `boolean`</li></ul></li><li>`steps`: _Object with properties:_<ul><li>`pre`: `Array<string _or_ _Object with dynamic keys of type_ string _and values of type_ _Object with dynamic keys of type_ string _and values of type_ unknown (_optional & nullable_)>`</li><li>`post`: `Array<string _or_ _Object with dynamic keys of type_ string _and values of type_ _Object with dynamic keys of type_ string _and values of type_ unknown (_optional & nullable_)>`</li><li>`custom`: `Array<string _or_ _Object with dynamic keys of type_ string _and values of type_ _Object with dynamic keys of type_ string _and values of type_ unknown (_optional & nullable_)>`</li></ul></li><li>`splitIntoMatrix`: `boolean`</li><li>`custom`: _Object with dynamic keys of type_ `string` _and values of type_ `unknown` (_optional & nullable_)</li></ul> |
44+
| `workflows` | an array of additional CircleCI workflows to output in the generated config. these reference jobs defined in the `jobs` option. | _Array of objects:_<br /><ul><li>`name`: `string`</li><li>`jobs`: _Array of objects:_<br /><ul><li>`name`: `string`</li><li>`requires`: `Array<string>`</li><li>`splitIntoMatrix`: `boolean`</li><li>`runOnRelease`: `boolean`</li><li>`custom`: _Object with dynamic keys of type_ `string` _and values of type_ `unknown` (_optional & nullable_)</li></ul></li><li>`runOnRelease`: `boolean`</li><li>`custom`: _Object with dynamic keys of type_ `string` _and values of type_ `unknown` (_optional & nullable_)</li></ul> |
45+
| `custom` | arbitrary additional CircleCI configuration that will be merged into the Tool Kit-generated config. | _Object with dynamic keys of type_ `string` _and values of type_ `unknown` (_optional & nullable_) |
46+
| `disableBaseConfig` | set to `true` to omit the Tool Kit CircleCI boilerplate. should be used along with `custom` to provide your own boilerplate. | `boolean` |
4747

4848
_All properties are optional._
4949

0 commit comments

Comments
 (0)