Skip to content
This repository was archived by the owner on Aug 29, 2023. It is now read-only.

Commit 1100c54

Browse files
committed
add all fields that might appear in config context
1 parent 359f6a5 commit 1100c54

File tree

1 file changed

+12
-9
lines changed

1 file changed

+12
-9
lines changed

templates/README.md

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,21 +23,24 @@ ${{{ <context> }}}
2323

2424
The `config` context is the configuration object because of which the file is being copied.
2525

26-
| Property name | Type | Description |
27-
| --- | --- | --- |
28-
| `config` | `object` | The top-level context. |
29-
| `config.files` | `array` | The files that are being copied. |
30-
| `config.extra_files` | `object` | The additional files that are also being copied. |
31-
| `config.target` | `string` | The name of the target repository in `{owner}/{repo}` format. |
26+
| Property name | Type | Always present | Description |
27+
| --- | --- | --- | --- |
28+
| `config` | `object` | `true` | The top-level context. | true |
29+
| `config.files` | `array` | `true` | The files that are being copied. |
30+
| `config.extra_files` | `array` | `false` | The additional files that are also being copied. |
31+
| `config.target` | `string` | `true` | The name of the target repository in `{owner}/{repo}` format. |
32+
| `config.deploy_go` | `boolean` | `false` | Flag controling if Go specific setup should be applied to the repository. |
33+
| `config.deploy_versioning` | `boolean` | `false` | Flag controling if `versions.json` file should be deployed to the repository. |
34+
| `config.dist` | `string` | `false` | The name of the distribution built from the repository. |
3235

3336
#### `github` context
3437

3538
The `github` context contains information about the target repository the file is being copied to.
3639

37-
| Property name | Type | Description |
40+
| Property name | Type | Always present | Description |
3841
| --- | --- | --- |
39-
| `github` | `object` | The top-level context. |
40-
| `github.default_branch` | `string` | The name of the default branch of the target repository. |
42+
| `github` | `object` | `true` | The top-level context. |
43+
| `github.default_branch` | `string` | `true` | The name of the default branch of the target repository. |
4144

4245
### Examples
4346

0 commit comments

Comments
 (0)