-
Notifications
You must be signed in to change notification settings - Fork 34
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
ca597ad
commit 59e3c31
Showing
40 changed files
with
435 additions
and
138 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -118,7 +118,7 @@ | |
</span></span><span style=display:flex><span> registry: https://registry.npmjs.org | ||
</span></span><span style=display:flex><span><span style=color:#a40000>- username: npmUsername | ||
</span></span></span><span style=display:flex><span><span style=color:#a40000>- password: superSecretPassword | ||
</span></span></span></code></pre></div><h2 id=parameters>Parameters</h2><p>The following parameters are used to configure the image:</p><table><thead><tr><th>Name</th><th>Description</th><th>Required</th><th>Default</th><th>Environment Variables</th></tr></thead><tbody><tr><td><code>username</code></td><td>username for communication with npm</td><td><code>true</code></td><td><code>N/A</code></td><td><code>PARAMETER_USERNAME</code><br><code>NPM_USERNAME</code></td></tr><tr><td><code>password</code></td><td>password for communication with npm</td><td><code>false</code></td><td><code>N/A</code></td><td><code>PARAMETER_PASSWORD</code><br><code>NPM_PASSWORD</code></td></tr><tr><td><code>email</code></td><td>email for communication with npm</td><td><code>false</code></td><td><code>N/A</code></td><td><code>PARAMETER_EMAIL</code><br><code>NPM_EMAIL</code></td></tr><tr><td><code>token</code></td><td>auth token for communication with npm</td><td><code>false</code></td><td><code>N/A</code></td><td><code>PARAMETER_TOKEN</code><br><code>TOKEN</code></td></tr><tr><td><code>registry</code></td><td>npm instance to communicate with</td><td><code>false</code></td><td><code>https://registry.npmjs.org</code></td><td><code>PARAMETER_REGISTRY</code><br><code>NPM_REGISTRY</code></td></tr><tr><td><code>audit_level</code></td><td>level at which the audit check should fail (valid options: <code>low</code>, <code>moderate</code>, <code>high</code>, <code>critical</code>, <code>none</code> to skip)</td><td><code>false</code></td><td><code>low</code></td><td><code>PARAMETER_AUDIT_LEVEL</code><br><code>AUDIT_LEVEL</code></td></tr><tr><td><code>strict_ssl</code></td><td>whether or not to do SSL key validation during communication</td><td><code>false</code></td><td><code>true</code></td><td><code>PARAMETER_STRICT_SSL</code><br><code>STRICT_SSL</code></td></tr><tr><td><code>always_auth</code></td><td>force npm to always require authentication</td><td><code>false</code></td><td><code>false</code></td><td><code>PARAMETER_ALWAYS_AUTH</code><br><code>ALWAYS_AUTH</code></td></tr><tr><td><code>skip_ping</code></td><td>whether or not to skip <code>npm ping</code> authentication command</td><td><code>false</code></td><td><code>false</code></td><td><code>PARAMETER_SKIP_PING</code><br><code>SKIP_PING</code></td></tr><tr><td><code>dry_run</code></td><td>enables pretending to perform the action</td><td><code>false</code></td><td><code>false</code></td><td><code>PARAMETER_DRY_RUN</code><br><code>DRY_RUN</code></td></tr><tr><td><code>tag</code></td><td>publish package with given alias tag</td><td><code>false</code></td><td><code>latest</code></td><td><code>PARAMETER_TAG</code><br><code>TAG</code></td></tr><tr><td><code>log_level</code></td><td>set the log level for the plugin (valid options: <code>info</code>, <code>debug</code>, <code>trace</code>)</td><td><code>true</code></td><td><code>info</code></td><td><code>PARAMETER_LOG_LEVEL</code><br><code>LOG_LEVEL</code></td></tr><tr><td><code>workspaces</code></td><td>publish all workspaces</td><td><code>false</code></td><td><code>false</code></td><td><code>PARAMETER_WORKSPACES</code><br><code>WORKSPACES</code></td></tr><tr><td><code>workspace</code></td><td>publish a specific workspace by specifying the workspace name or relative path</td><td><code>false</code></td><td><code>N/A</code></td><td><code>PARAMETER_WORKSPACE</code><br><code>WORKSPACE</code></td></tr><tr><td><code>access</code></td><td>Tells the registry whether this package should be published as public or restricted. Only applies to scoped packages, which default to restricted</td><td><code>false</code></td><td><code>restricted</code></td><td><code>PARAMETER_ACCESS</code><br><code>ACCESS</code></td></tr></tbody></table><h2 id=packagejson>package.json</h2><p>This is your module’s manifest. There are a few important keys that need to be set in order to publish your module</p><ul><li><strong>name</strong> - your package name that will be checked against in the registry</li><li><strong>version</strong> - your package version that will be used to publish, it must be valid semver and unique to the registry</li><li><strong>private</strong> - this needs to be set to <code>false</code> even if you are publishing it internally.</li><li><strong>publishConfig</strong> - this should be configured to your registry location and registry parameter should match this value</li></ul><p>For example values, see npm’s <a href=https://docs.npmjs.com/files/package.json>documentation</a></p><h2 id=template>Template</h2><p>COMING SOON!</p><h2 id=troubleshooting>Troubleshooting</h2><p>Here are the available log levels to assist in troubleshooting: | ||
</span></span></span></code></pre></div><h2 id=parameters>Parameters</h2><p>The following parameters are used to configure the image:</p><table><thead><tr><th>Name</th><th>Description</th><th>Required</th><th>Default</th><th>Environment Variables</th></tr></thead><tbody><tr><td><code>username</code></td><td>username for communication with npm</td><td><code>true</code></td><td><code>N/A</code></td><td><code>PARAMETER_USERNAME</code><br><code>NPM_USERNAME</code></td></tr><tr><td><code>password</code></td><td>password for communication with npm</td><td><code>false</code></td><td><code>N/A</code></td><td><code>PARAMETER_PASSWORD</code><br><code>NPM_PASSWORD</code></td></tr><tr><td><code>email</code></td><td>email for communication with npm</td><td><code>false</code></td><td><code>N/A</code></td><td><code>PARAMETER_EMAIL</code><br><code>NPM_EMAIL</code></td></tr><tr><td><code>token</code></td><td>auth token for communication with npm</td><td><code>false</code></td><td><code>N/A</code></td><td><code>PARAMETER_TOKEN</code><br><code>TOKEN</code></td></tr><tr><td><code>registry</code></td><td>npm instance to communicate with</td><td><code>false</code></td><td><code>https://registry.npmjs.org</code></td><td><code>PARAMETER_REGISTRY</code><br><code>NPM_REGISTRY</code></td></tr><tr><td><code>audit_level</code></td><td>level at which the audit check should fail (valid options: <code>low</code>, <code>moderate</code>, <code>high</code>, <code>critical</code>, <code>none</code> to skip)</td><td><code>false</code></td><td><code>none</code></td><td><code>PARAMETER_AUDIT_LEVEL</code><br><code>AUDIT_LEVEL</code></td></tr><tr><td><code>strict_ssl</code></td><td>whether or not to do SSL key validation during communication</td><td><code>false</code></td><td><code>true</code></td><td><code>PARAMETER_STRICT_SSL</code><br><code>STRICT_SSL</code></td></tr><tr><td><code>always_auth</code></td><td>force npm to always require authentication</td><td><code>false</code></td><td><code>false</code></td><td><code>PARAMETER_ALWAYS_AUTH</code><br><code>ALWAYS_AUTH</code></td></tr><tr><td><code>skip_ping</code></td><td>whether or not to skip <code>npm ping</code> authentication command</td><td><code>false</code></td><td><code>false</code></td><td><code>PARAMETER_SKIP_PING</code><br><code>SKIP_PING</code></td></tr><tr><td><code>dry_run</code></td><td>enables pretending to perform the action</td><td><code>false</code></td><td><code>false</code></td><td><code>PARAMETER_DRY_RUN</code><br><code>DRY_RUN</code></td></tr><tr><td><code>tag</code></td><td>publish package with given alias tag</td><td><code>false</code></td><td><code>latest</code></td><td><code>PARAMETER_TAG</code><br><code>TAG</code></td></tr><tr><td><code>log_level</code></td><td>set the log level for the plugin (valid options: <code>info</code>, <code>debug</code>, <code>trace</code>)</td><td><code>true</code></td><td><code>info</code></td><td><code>PARAMETER_LOG_LEVEL</code><br><code>LOG_LEVEL</code></td></tr><tr><td><code>workspaces</code></td><td>publish all workspaces</td><td><code>false</code></td><td><code>false</code></td><td><code>PARAMETER_WORKSPACES</code><br><code>WORKSPACES</code></td></tr><tr><td><code>workspace</code></td><td>publish a specific workspace by specifying the workspace name or relative path</td><td><code>false</code></td><td><code>N/A</code></td><td><code>PARAMETER_WORKSPACE</code><br><code>WORKSPACE</code></td></tr><tr><td><code>access</code></td><td>Tells the registry whether this package should be published as public or restricted. Only applies to scoped packages, which default to restricted</td><td><code>false</code></td><td><code>restricted</code></td><td><code>PARAMETER_ACCESS</code><br><code>ACCESS</code></td></tr></tbody></table><h2 id=packagejson>package.json</h2><p>This is your module’s manifest. There are a few important keys that need to be set in order to publish your module</p><ul><li><strong>name</strong> - your package name that will be checked against in the registry</li><li><strong>version</strong> - your package version that will be used to publish, it must be valid semver and unique to the registry</li><li><strong>private</strong> - this needs to be set to <code>false</code> even if you are publishing it internally.</li><li><strong>publishConfig</strong> - this should be configured to your registry location and registry parameter should match this value</li></ul><p>For example values, see npm’s <a href=https://docs.npmjs.com/files/package.json>documentation</a></p><h2 id=template>Template</h2><p>COMING SOON!</p><h2 id=troubleshooting>Troubleshooting</h2><p>Here are the available log levels to assist in troubleshooting: | ||
trace, debug, info, warn, error, fatal, panic</p><div class="text-muted mt-5 pt-3 border-top">Last modified September 1, 2022: <a href=https://github.com/go-vela/docs/commit/fa9bbf5a562ce6b2d273f31015760239579e5a22>feat: npm plugin docs (#317) (fa9bbf5a)</a></div></div></main></div></div><footer class="bg-dark py-5 row d-print-none"><div class="container-fluid mx-sm-5"><div class=row><div class="col-6 col-sm-4 text-xs-center order-sm-2"></div><div class="col-6 col-sm-4 text-right text-xs-center order-sm-3"><ul class="list-inline mb-0"><li class="list-inline-item mx-2 h3" data-toggle=tooltip data-placement=top title=GitHub aria-label=GitHub><a class=text-white target=_blank href=https://github.com/go-vela><i class="fab fa-github"></i></a></li><li class="list-inline-item mx-2 h3" data-toggle=tooltip data-placement=top title=Slack aria-label=Slack><a class=text-white target=_blank href="https://gophers.slack.com/app_redirect?channel=CNRRKE8KY"><i class="fab fa-slack"></i></a></li><li class="list-inline-item mx-2 h3" data-toggle=tooltip data-placement=top title="Developer mailing list" aria-label="Developer mailing list"><a class=text-white target=_blank href=mailto:[email protected]><i class="fa fa-envelope"></i></a></li></ul></div><div class="col-12 col-sm-4 text-center py-2 order-sm-2"><small class=text-white>© 2024 Target Brands All Rights Reserved</small> | ||
<small class=ml-1><a href=https://github.com/go-vela/server/blob/main/LICENSE target=_blank>Privacy Policy</a></small></div></div></div></footer></div><script src=https://cdnjs.cloudflare.com/ajax/libs/popper.js/2.11.8/umd/popper.min.js integrity="sha512-TPh2Oxlg1zp+kz3nFA0C5vVC6leG/6mm1z9+mA81MI5eaUVqasPLO8Cuk4gMF4gUfP5etR73rgU/8PNMsSesoQ==" crossorigin=anonymous></script> | ||
<script src=https://stackpath.bootstrapcdn.com/bootstrap/4.1.3/js/bootstrap.min.js integrity=sha384-ChfqqxuZUCnJSK3+MXmPNIyE6ZbWh2IMqE241rYiqJxyMiZ6OW/JmZQ5stwEULTy crossorigin=anonymous></script> | ||
|
Large diffs are not rendered by default.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.