Source

View on GitHub

Run NPX command

step

Run NPX command in the context of a git resource.

Specification

command

Required

string

Executes command by installing latest package from the npm registry.

packageFolder

Optional

string

Location of the folder in which to run the npx command.

nodeVersion

Optional

string

Optional Node.js version. If unspecified, the latest LTS version will be used (as defined by the Debian-based node:lts image). The version string can be any version installable by nvm. To use an .nvmrc file in your repository to specify a Node.js version, you must specify a nodeVersion of "auto".

flags

Optional

object

Optional flags passed to npx.

flags.package

Optional

string

Can be used when the binary name does not match the package name or for packages with multiple binaries if you want to call one of the other executables.

commandFlags

Optional

object

Optional flags passed to the command.

git

Optional

object

A map of git configuration. If you're using HTTPS, only name and repository are required.

git.ssh_key

Required

string

The SSH key to use when cloning the git repository. You can pass the key to Relay as a secret. See the example below.

git.known_hosts

Optional

string

SSH known hosts file. Use a Relay secret to pass the contents of the file into the workflow as a base64-encoded string. See the example below.

git.name

Required

string

A directory name for the git clone.

git.branch

Optional

string

The Git branch to clone.

git.repository

Required

string

The git repository URL.

npm

Optional

object

NPM credentials

npm.token

Optional

string

Optional NPM token (created via `npm token create`) for things like publishing.

NPX integration for Relay.sh

This npx step container runs an npx command.

Steps

| Name | Description | |------|-------------| | steps/npx-step-run-command | Run an npx command |

Contributing

Issues

Feel free to submit issues and enhancement requests.

Contributing Code

In general, we follow the "fork-and-pull" Git workflow.

Fork the repo on GitHub
Clone the project to your own machine
Commit changes to your own branch
Push your work back up to your fork
Submit a Pull request so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull request!

License

As indicated by the repository, this project is licensed under Apache 2.0.

Example step configuration

1name: npx
2image: relaysh/npx-step-run-command
3spec:
4  command: cowsay hello world
5

1name: npx
2image: relaysh/npx-step-run-command
3spec:
4  command: lerna publish
5  flags:
6    quiet: true
7  commandFlags:
8    yes: true
9  git:
10    name: design-system,
11    repository: https://github.com/puppetlabs/design-system.git
12  packageFolder: packages/react-components
13  npm:
14    token:
15      $type: Secret
16      name: npm_token
17

Join our community

We’re excited to see and share in our community’s creation. Take a look at our community overview to learn how to begin contributing to Relay.

Ready to get started?

With Relay you can create event-based workflows that are fully automated.

Start automating

Source

Run NPX command

Specification

Required

Required

Required

Required

NPX integration for Relay.sh

Steps

Contributing

Issues

Contributing Code

License

Example step configuration

Join our community

Ready to get started?

Documentation

Blog

Privacy policy

Terms of Use

Pricing

Privacy policy

Terms of Use