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.

Sign up for GitHub

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

Jump to bottom

(docs) expand more on the "default" field for parameters #2927

Merged
merged 4 commits into from
Oct 17, 2023
Merged

(docs) expand more on the "default" field for parameters #2927

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0d078e8
update document to expand on param defaults
schristoff Sep 25, 2023
987c0f7
make docs better
schristoff Sep 28, 2023
1adfb99
Merge branch 'main' into schristoff_defaultingparams
schristoff Sep 28, 2023
7c43c43
Merge branch 'main' into schristoff_defaultingparams
schristoff Oct 10, 2023
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
9 changes: 9 additions & 0 deletions docs/content/wiring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,15 @@ You can also provide any other attributes, as specified by the CNAB [parameters]
default: "wordpress"
```

If you decide to use the default parameter field, you must set it as the empty value.
However, it must be passed in as an empty type. For example, for an empty string, pass in `""` as the default, or for an object use `{}`:

```yaml
- name: command
type: object
default: {}
```

### File Parameters

Porter also enables the use of file parameters in a bundle.
Expand Down
Loading