Skip to content

Commit

Permalink
deploy: 40d453b
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Feb 6, 2024
1 parent b2e9d3f commit 35c98d6
Show file tree
Hide file tree
Showing 11 changed files with 12 additions and 11 deletions.
2 changes: 1 addition & 1 deletion 404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.0.0">
<title data-rh="true">Jalapeno</title><meta data-rh="true" property="og:title" content="Jalapeno"><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://futurice.github.io/jalapeno/404.html"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><link data-rh="true" rel="icon" href="/jalapeno/img/logo.svg"><link data-rh="true" rel="canonical" href="https://futurice.github.io/jalapeno/404.html"><link data-rh="true" rel="alternate" href="https://futurice.github.io/jalapeno/404.html" hreflang="en"><link data-rh="true" rel="alternate" href="https://futurice.github.io/jalapeno/404.html" hreflang="x-default"><link rel="stylesheet" href="/jalapeno/assets/css/styles.3795cfa1.css">
<script src="/jalapeno/assets/js/runtime~main.b3e09afd.js" defer="defer"></script>
<script src="/jalapeno/assets/js/runtime~main.dd3d2a72.js" defer="defer"></script>
<script src="/jalapeno/assets/js/main.6ac339eb.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
Expand Down
4 changes: 2 additions & 2 deletions api.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="UTF-8">
<meta name="generator" content="Docusaurus v3.0.0">
<title data-rh="true">API Reference | Jalapeno</title><meta data-rh="true" name="viewport" content="width=device-width,initial-scale=1"><meta data-rh="true" name="twitter:card" content="summary_large_image"><meta data-rh="true" property="og:url" content="https://futurice.github.io/jalapeno/api"><meta data-rh="true" property="og:locale" content="en"><meta data-rh="true" name="docusaurus_locale" content="en"><meta data-rh="true" name="docsearch:language" content="en"><meta data-rh="true" name="docusaurus_version" content="current"><meta data-rh="true" name="docusaurus_tag" content="docs-default-current"><meta data-rh="true" name="docsearch:version" content="current"><meta data-rh="true" name="docsearch:docusaurus_tag" content="docs-default-current"><meta data-rh="true" property="og:title" content="API Reference | Jalapeno"><meta data-rh="true" name="description" content="CLI"><meta data-rh="true" property="og:description" content="CLI"><link data-rh="true" rel="icon" href="/jalapeno/img/logo.svg"><link data-rh="true" rel="canonical" href="https://futurice.github.io/jalapeno/api"><link data-rh="true" rel="alternate" href="https://futurice.github.io/jalapeno/api" hreflang="en"><link data-rh="true" rel="alternate" href="https://futurice.github.io/jalapeno/api" hreflang="x-default"><link rel="stylesheet" href="/jalapeno/assets/css/styles.3795cfa1.css">
<script src="/jalapeno/assets/js/runtime~main.b3e09afd.js" defer="defer"></script>
<script src="/jalapeno/assets/js/runtime~main.dd3d2a72.js" defer="defer"></script>
<script src="/jalapeno/assets/js/main.6ac339eb.js" defer="defer"></script>
</head>
<body class="navigation-with-keyboard">
Expand Down Expand Up @@ -94,7 +94,7 @@ <h4 class="anchor anchorWithStickyNavbar_FNw8" id="why-options">Options<a href="
<hr>
<h2 class="anchor anchorWithStickyNavbar_FNw8" id="recipe-schema-recipeyml">Recipe schema (<code>recipe.yml</code>)<a href="#recipe-schema-recipeyml" class="hash-link" aria-label="Direct link to recipe-schema-recipeyml" title="Direct link to recipe-schema-recipeyml">​</a></h2>
<p><a href="https://github.com/futurice/jalapeno/blob/main/pkg/recipe/recipe.go#L7" target="_blank" rel="noopener noreferrer">Source code</a></p>
<table><thead><tr><th>Attribute</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>apiVersion</code></td><td><code>string</code></td><td><code>v1</code></td><td>Version of the recipe metadata API schema. Currently should have value &quot;v1&quot;.</td></tr><tr><td><code>name</code></td><td><code>string</code></td><td></td><td>Name of the recipe.</td></tr><tr><td><code>version</code></td><td><code>string</code></td><td></td><td>Version of the recipe. Must be valid <a href="https://semver.org/" target="_blank" rel="noopener noreferrer">semver</a>.</td></tr><tr><td><code>description</code></td><td><code>string</code></td><td></td><td>Description of what the recipe does</td></tr><tr><td><code>sources</code></td><td><code>[]string</code></td><td></td><td>A list of URLs to source code for this recipe.</td></tr><tr><td><code>templateExtension</code></td><td><code>string</code></td><td></td><td>File extension of files in &quot;templates&quot; directory which should be templated. Files not matched by this extension will be copied as-is. If left empty (the default), all files will be templated.</td></tr><tr><td><code>initHelp</code></td><td><code>string</code></td><td></td><td>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.</td></tr><tr><td><code>ignorePatterns</code></td><td><code>[]string</code></td><td></td><td>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.</td></tr><tr><td><code>vars</code></td><td><a href="#variable"><code>[]Variable</code></a></td><td></td><td>An array of variables which can be used in templates. The user will be prompted to provide the value for the variable if not set with <code>--set</code> flag.</td></tr></tbody></table>
<table><thead><tr><th>Attribute</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>apiVersion</code></td><td><code>string</code></td><td><code>v1</code></td><td>Version of the recipe metadata API schema. Currently should have value &quot;v1&quot;.</td></tr><tr><td><code>name</code></td><td><code>string</code></td><td></td><td>Name of the recipe.</td></tr><tr><td><code>version</code></td><td><code>string</code></td><td></td><td>Version of the recipe. Must be valid <a href="https://semver.org/" target="_blank" rel="noopener noreferrer">semver</a>.</td></tr><tr><td><code>description</code></td><td><code>string</code></td><td></td><td>Description of what the recipe does</td></tr><tr><td><code>source</code></td><td><code>string</code></td><td></td><td>URL to source code for this recipe.</td></tr><tr><td><code>templateExtension</code></td><td><code>string</code></td><td></td><td>File extension of files in &quot;templates&quot; directory which should be templated. Files not matched by this extension will be copied as-is. If left empty (the default), all files will be templated.</td></tr><tr><td><code>initHelp</code></td><td><code>string</code></td><td></td><td>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.</td></tr><tr><td><code>ignorePatterns</code></td><td><code>[]string</code></td><td></td><td>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.</td></tr><tr><td><code>vars</code></td><td><a href="#variable"><code>[]Variable</code></a></td><td></td><td>An array of variables which can be used in templates. The user will be prompted to provide the value for the variable if not set with <code>--set</code> flag.</td></tr></tbody></table>
<h3 class="anchor anchorWithStickyNavbar_FNw8" id="variable">Variable<a href="#variable" class="hash-link" aria-label="Direct link to Variable" title="Direct link to Variable">​</a></h3>
<p><a href="https://github.com/futurice/jalapeno/blob/main/pkg/recipe/variable.go#L13" target="_blank" rel="noopener noreferrer">Source code</a></p>
<table><thead><tr><th>Attribute</th><th>Type</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>name</code></td><td><code>string</code></td><td></td><td>The name of the variable. It is also used as unique identifier, so two variables can not have the same name.</td></tr><tr><td><code>description</code></td><td><code>string</code></td><td></td><td>Description of the variable. Will be shown to the user when &quot;show help&quot; is activated.</td></tr><tr><td><code>default</code></td><td><code>string</code></td><td></td><td>Default value of the variable.</td></tr><tr><td><code>confirm</code></td><td><code>bool</code></td><td><code>false</code></td><td>If set to true, the prompt will be yes/no question, and the value type will be boolean.</td></tr><tr><td><code>optional</code></td><td><code>bool</code></td><td><code>false</code></td><td>If set to true, the variable can be left empty.</td></tr><tr><td><code>options</code></td><td><code>[]string</code></td><td></td><td>The user selects the value from a list of options.</td></tr><tr><td><code>validators</code></td><td><a href="#validator"><code>[]Validator</code></a></td><td></td><td>Validators for the variable.</td></tr><tr><td><code>if</code></td><td><code>string</code></td><td></td><td>Makes the variable conditional based on the result of the expression. The result of the evaluation needs to be a boolean value. Uses <a href="https://github.com/expr-lang/expr" target="_blank" rel="noopener noreferrer">https://github.com/expr-lang/expr</a>.</td></tr><tr><td><code>columns</code></td><td><code>[]string</code></td><td></td><td>Set the variable as a table type with columns defined by this property.</td></tr></tbody></table>
Expand Down
2 changes: 1 addition & 1 deletion assets/js/5fbc5cf1.e61869ca.js → assets/js/5fbc5cf1.12e0c3c0.js
View file

Large diffs are not rendered by default.

Loading

0 comments on commit 35c98d6

Please sign in to comment.