https://github.com/capistrano/npm
Capistrano extension for npm
https://github.com/capistrano/npm
Last synced: over 1 year ago
JSON representation
Capistrano extension for npm
- Host: GitHub
- URL: https://github.com/capistrano/npm
- Owner: capistrano
- License: mit
- Created: 2013-06-06T23:27:57.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2018-12-13T00:08:32.000Z (over 7 years ago)
- Last Synced: 2024-10-29T01:13:59.580Z (over 1 year ago)
- Language: Ruby
- Size: 24.4 KB
- Stars: 157
- Watchers: 5
- Forks: 51
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Capistrano::npm
npm support for Capistrano 3.x
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'capistrano', '~> 3.1.0'
gem 'capistrano-npm'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install capistrano-npm
## Usage
Require in `Capfile` to use the default task:
```ruby
require 'capistrano/npm'
```
The task will run before `deploy:updated` as part of Capistrano's default deploy,
or can be run in isolation with `cap production npm:install`
Configurable options:
```ruby
set :npm_target_path, -> { release_path.join('subdir') } # default not set
set :npm_flags, '--production --silent --no-progress' # default
set :npm_roles, :all # default
set :npm_env_variables, {} # default
set :npm_method, 'install' # default
```
### NPM Method
As of version 5.7.0 of npm, a new install method (`ci`) was introduced which utilises
the `package-lock.json` file. Change `npm_method` to `ci` in order to use make
use of the improved installation method.
### Dependencies
npm allows for normal `dependencies` and `devDependencies`. By default this gem uses `'--production --silent --no-progress'` as the install flags which will **only** install `dependencies` and skip `devDependencies`. If you want your `devDependencies` installed as well, then remove `--production`.
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request