Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(core): add project outputs and garden get outputs command #1546

Merged
merged 1 commit into from
Jan 27, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 36 additions & 36 deletions docs/module-types/conftest.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace.

> Note: In many cases, you'll let specific conftest providers (e.g. [`conftest-container`](../providers/conftest-container.md) and [`conftest-kubernetes`](../providers/conftest-kubernetes.md) create this module type automatically, but you may in some cases want or need to manually specify files to test.

See the [conftest docs](https://github.com/instramenta/conftest) for details on how to configure policies.
See the [conftest docs](https://github.com/instrumenta/conftest) for details on how to configure policies.

## Reference

Expand Down Expand Up @@ -126,15 +126,15 @@ files:

The schema version of this module's config (currently not used).

| Type | Required | Allowed Values | Default |
| -------- | -------- | -------------- | ---------------- |
| `string` | Yes | "garden.io/v0" | `"garden.io/v0"` |
| Type | Allowed Values | Default | Required |
| -------- | -------------- | ---------------- | -------- |
| `string` | "garden.io/v0" | `"garden.io/v0"` | Yes |

#### `kind`

| Type | Required | Allowed Values | Default |
| -------- | -------- | -------------- | ---------- |
| `string` | Yes | "Module" | `"Module"` |
| Type | Allowed Values | Default | Required |
| -------- | -------------- | ---------- | -------- |
| `string` | "Module" | `"Module"` | Yes |

#### `type`

Expand Down Expand Up @@ -187,9 +187,9 @@ module's service or task outputs (i.e. runtime outputs) will fail to resolve whe
so you need to make sure to provide alternate values for those if you're using them, using conditional
expressions.

| Type | Required | Default |
| --------- | -------- | ------- |
| `boolean` | No | `false` |
| Type | Default | Required |
| --------- | ------- | -------- |
| `boolean` | `false` | No |

#### `include`

Expand Down Expand Up @@ -262,27 +262,27 @@ repositoryUrl: "git+https://github.com/org/repo.git#v2.0"

When false, disables pushing this module to remote registries.

| Type | Required | Default |
| --------- | -------- | ------- |
| `boolean` | No | `true` |
| Type | Default | Required |
| --------- | ------- | -------- |
| `boolean` | `true` | No |

#### `build`

Specify how to build the module. Note that plugins may define additional keys on this object.

| Type | Required | Default |
| -------- | -------- | --------------------- |
| `object` | No | `{"dependencies":[]}` |
| Type | Default | Required |
| -------- | --------------------- | -------- |
| `object` | `{"dependencies":[]}` | No |

#### `build.dependencies[]`

[build](#build) > dependencies

A list of modules that must be built before this module is built.

| Type | Required | Default |
| --------------- | -------- | ------- |
| `array[object]` | No | `[]` |
| Type | Default | Required |
| --------------- | ------- | -------- |
| `array[object]` | `[]` | No |

Example:

Expand All @@ -309,9 +309,9 @@ Module name to build ahead of this module.

Specify one or more files or directories to copy from the built dependency to this module.

| Type | Required | Default |
| --------------- | -------- | ------- |
| `array[object]` | No | `[]` |
| Type | Default | Required |
| --------------- | ------- | -------- |
| `array[object]` | `[]` | No |

#### `build.dependencies[].copy[].source`

Expand All @@ -330,9 +330,9 @@ POSIX-style path or filename of the directory or file(s) to copy to the target.
POSIX-style path or filename to copy the directory or file(s), relative to the build directory.
Defaults to to same as source path.

| Type | Required | Default |
| ----------- | -------- | ------- |
| `posixPath` | No | `""` |
| Type | Default | Required |
| ----------- | ------- | -------- |
| `posixPath` | `""` | No |

#### `sourceModule`

Expand All @@ -357,9 +357,9 @@ Defaults to the `policyPath` set in the provider config.

The policy namespace in which to find _deny_ and _warn_ rules.

| Type | Required | Default |
| Type | Default | Required |
| -------- | -------- | -------- |
| `string` | No | `"main"` |
| `string` | `"main"` | No |

#### `files`

Expand All @@ -381,9 +381,9 @@ modules.

The build path of the module.

| Type | Required |
| -------- | -------- |
| `string` | Yes |
| Type |
| -------- |
| `string` |

Example:

Expand All @@ -395,9 +395,9 @@ my-variable: ${modules.my-module.buildPath}

The local path of the module.

| Type | Required |
| -------- | -------- |
| `string` | Yes |
| Type |
| -------- |
| `string` |

Example:

Expand All @@ -409,9 +409,9 @@ my-variable: ${modules.my-module.path}

The current version of the module.

| Type | Required |
| -------- | -------- |
| `string` | Yes |
| Type |
| -------- |
| `string` |

Example:

Expand Down
Loading