Skip to content

Commit e327f1b

Browse files
apaleslimghostapaleslimghost
committed
docs: automatically regenerate schema docs
1 parent 51c9522 commit e327f1b

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

‎plugins/circleci/readme.md‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,12 +51,13 @@ _All properties are optional._
5151

5252
### `@dotcom-tool-kit/circleci`
5353

54-
| Property | Description | Type | Default |
55-
| :----------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :--------------------- | :-------------------------- |
56-
| `cimgNodeVersions` | list of CircleCI [Node.js image versions](https://circleci.com/developer/images/image/cimg/node) to use. if more than one is provided, a [matrix build](https://circleci.com/docs/using-matrix-jobs/) will be generated in your CircleCI config. | `Array<string>` | `["20.19-browsers"]` |
57-
| `cypressImage` | the Cypress docker image to use. see https://github.com/cypress-io/cypress-docker-images for available images and tags. if this option is present, and you're using the [`circleci-deploy`](../circleci-deploy) plugin, this will override the default `node` executor for the `e2e-test-review` and `e2e-test-staging` jobs. | `string` | |
58-
| `tagFilter` | the regular expression used to match tags for jobs that should run on tag workflows. by default, matches tags that look like `v1.2.3`; if your releases use a different tag format, change this option to match your tags. set to `false` to prevent running workflows on tags, for example if your repo doesn't do versioned releases. | `string \| false` | `'/^v\d+\.\d+\.\d+(-.+)?/'` |
59-
| `checkoutMethod` | whether to checkout the full git repository or blobless (without files unrelated to the main commit.) blobless checkouts are the default and are faster, though some projects may encounter issues if they rely on inspecting files in the git history. if you see logs like `The authenticity of host 'github.com (140.82.113.4)' can't be established.` you should try enabling full checkouts. | `'full' \| 'blobless'` | |
54+
| Property | Description | Type | Default |
55+
| :----------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :---------------------------- | :-------------------------- |
56+
| `cimgNodeVersions` | list of CircleCI [Node.js image versions](https://circleci.com/developer/images/image/cimg/node) to use. if more than one is provided, a [matrix build](https://circleci.com/docs/using-matrix-jobs/) will be generated in your CircleCI config. | `Array<string>` | `["20.19-browsers"]` |
57+
| `cypressImage` | the Cypress docker image to use. see https://github.com/cypress-io/cypress-docker-images for available images and tags. if this option is present, and you're using the [`circleci-deploy`](../circleci-deploy) plugin, this will override the default `node` executor for the `e2e-test-review` and `e2e-test-staging` jobs. | `string` | |
58+
| `tagFilter` | the regular expression used to match tags for jobs that should run on tag workflows. by default, matches tags that look like `v1.2.3`; if your releases use a different tag format, change this option to match your tags. set to `false` to prevent running workflows on tags, for example if your repo doesn't do versioned releases. | `string \| false` | `'/^v\d+\.\d+\.\d+(-.+)?/'` |
59+
| `checkoutMethod` | whether to checkout the full git repository or blobless (without files unrelated to the main commit.) blobless checkouts are the default and are faster, though some projects may encounter issues if they rely on inspecting files in the git history. if you see logs like `The authenticity of host 'github.com (140.82.113.4)' can't be established.` you should try enabling full checkouts. | `'full' \| 'blobless'` | |
60+
| `orbDevVersion` | set this option to use a [development version](https://circleci.com/docs/orbs/author/orb-concepts/#development-orbs) of the Tool Kit CircleCI orb in the generated config | `string` (_regex: `/^dev:/`_) | |
6061

6162
_All properties are optional._
6263
<!-- end autogenerated docs -->

0 commit comments

Comments
 (0)