Skip to content

Commit

Permalink
Add documentation to custom section of Porter manifest
Browse files Browse the repository at this point in the history
Signed-off-by: joshuabezaleel <joshua.bezaleel@gmail.com>
  • Loading branch information
joshuabezaleel committed Apr 27, 2022
1 parent 301d359 commit ee6b09c
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/content/bundle/manifest/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -500,6 +500,7 @@ data.

```yaml
custom:
custom-config: "custom-value"
some-custom-config:
item: "value"
more-custom-config:
Expand All @@ -511,6 +512,12 @@ You can access custom data at runtime using the `bundle.custom.KEY.SUBKEY` templ
For example, `{{ bundle.custom.more-custom-config.enabled}}` allows you to
access nested values from the custom section.

Multiple custom values that were defined at the manifest can also be injected with new values during build time using the \--custom values tied to the `porter build` command. Currently only support string value. You can use dot notation to specify a nested field:

```
porter build --custom custom-config=new-custom-value --custom some-custom-config.item=edited-value
```

See the [Custom Extensions](https://github.com/cnabio/cnab-spec/blob/master/101-bundle-json.md#custom-extensions)
section of the CNAB Specification for more details.

Expand Down

0 comments on commit ee6b09c

Please sign in to comment.