Skip to content

Commit

Permalink
Document templateExtension in Recipe schema
Browse files Browse the repository at this point in the history
  • Loading branch information
Ilkka Poutanen committed Nov 30, 2023
1 parent d130598 commit 36823a6
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions cmd/docs/templates/schema.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
| `version` | `string` | | Version of the recipe. Must be valid [semver](https://semver.org/). |
| `description` | `string` | | Description of what the recipe does |
| `sources` | `[]string` | | A list of URLs to source code for this recipe. |
| `templateExtension` | `string` | `` | Extension of files in `sources` that are considered templates and are processed with the template engine. Must start with a period if not empty. |
| `initHelp` | `string` | | A message which will be showed to an user after a succesful recipe execution. Can be used to guide the user what should be done next in the project directory. |
| `ignorePatterns` | `[]string` | | Glob patterns for ignoring generated files from future recipe upgrades. Ignored files will not be regenerated even if their templates change in future versions of the recipe. |
| `vars` | [`[]Variable`](#variable) | | An array of variables which can be used in templates. The user will be prompted to provide the value for the variable if not predefined with `--set` flag. |
Expand Down

0 comments on commit 36823a6

Please sign in to comment.