adobe / create-whisk-action

Node package to automate the repetitive tasks of creating an OpenWhisk action

Create Whisk Action

Create OpenWhisk actions with no build configuration.

Quick Overview

npx create-whisk-action my-action
cd my-action

Then open the my-action folder in your favourite code editor and build your action like normal.

When you’re ready to deploy to production, create a minified bundle with npm run build.

Get Started Immediately

You don’t need to install or configure tools like Webpack. It is preconfigured and hidden so that you can focus on the code.

Just create a project, and you’re good to go.

Creating an Action

You’ll need to have Node >= 6 on your local development machine (but it’s not required on the server). You can use nvm (macOS/Linux) or nvm-windows to easily switch Node versions between different projects.

To create a new action, run a the command:

npx create-whisk-action my-action

To create a web action, add the --web option.

npx create-whisk-action my-action --web

It will create a directory called my-action inside the current folder. Inside that directory, it will generate the initial project structure and install the transitive dependencies:

my-action
├── config
│   └── webpack.config.js
├── node_modules
├── src
│   └── index.js
├── package-lock.json
└── package.json

No configuration or complicated folder structures, just the files you need to build your action.

Once the installation is done, you can open your project folder:

cd my-action

Inside the newly created project, you can run some built-in commands:

npm run build

Builds a webpack bundle as the file dist/bundle.js which can be deployed as an action.

npm run deploy

Deploys the action to your OpenWhisk instance.

Contributing

We'd love to have your helping hand on create-whisk-action! See CONTRIBUTING.md for more information on what we're looking for and how to get started.

Acknowledgements

We are grateful to the authors of existing related projects for their ideas. This package owes it's inspiration to create-react-app.

License

Create Whisk Action is open source software licensed as Apache-2.0.

create-whisk-action's Issues

Consider using package.json `engines` instead of checking for node version in index.js

Was just a thought ? Perhaps easier than implementing our own version checking?

https://docs.npmjs.com/files/package.json#engines

Support Package when creating action

Expected Behaviour

Openwhisk cli supports actions prefixed with a package name.

Actual Behaviour

create-whisk-action expects a project directory but does not support path delimiter (/).

Reproduce Scenario (including but not limited to)

$ npx create-whisk-action package/doStuff

Could not create a project called "package/doStuff" because of npm naming restrictions:
printValidationResults is not defined

Steps to Reproduce

Platform and Version

MacOs, node 6

Sample Code that illustrates the problem

Logs taken while reproducing problem

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on Greenkeeper branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please click the 'fix repo' button on account.greenkeeper.io.

Security vulnerabilities present in dependencies

Expected Behaviour

No security vulnerabilities to be present in dependencies.

Actual Behaviour

Security vulnerabilities are present in dependencies:

Known moderate severity security vulnerability detected in qs < 1.0.0 defined in package-lock.json.

package-lock.json update suggested: qs ~> 1.0.0.

Known moderate severity security vulnerability detected in hoek < 4.2.1 defined in package-lock.json.

package-lock.json update suggested: hoek ~> 4.2.1.