Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stve/capistrano-local-precompile

Fast asset compilation and deployment for your Rails app
https://github.com/stve/capistrano-local-precompile

Last synced: 7 days ago
JSON representation

Fast asset compilation and deployment for your Rails app

Awesome Lists containing this project

README

        

# Capistrano Local Precompile

If your Rails apps are anything like mine, one of the slowest parts of your deployment is waiting for asset pipeline precompilation. It's sometimes so slow, it's painful. So I went searching for some solutions. [turbo-sprockets](https://github.com/ndbroadbent/turbo-sprockets-rails3) helped, but it's not a silver bullet. This gem isn't a silver bullet either, but it can help. Capistrano Local Precompile takes a different approach. It builds your assets locally and rsync's them to your web server(s).

## Usage

Add capistrano-local-precompile to your Gemfile:

```ruby
group :development do
# Capistrano v2 should use '~> 0.0.5'
# Capistrano v3 should use '~> 1.0.0'
# Capistrano v3.8+ should use '~> 1.2.0'
gem 'capistrano-local-precompile', '~> 1.2.0', require: false
end
```

Then add the following line to your `Capfile`:

```ruby
require 'capistrano/local_precompile'
```

Remove the following line from your `Capfile`:

```ruby
require 'capistrano/rails/assets'
```

Here's the full set of configurable options:

```ruby
set :precompile_env # default: fetch(:rails_env) || 'production'
set :assets_dir # default: "public/assets"
set :rsync_cmd # default: "rsync -av --delete"
```

Capistrano supports **dry run** mode. In that case the `rsync` command will not actually be run but only shown in stdout:

```
cap production deploy --dry-run
```

## Acknowledgement

This gem is derived from gists by [uhlenbrock][] and [keighl][].

[uhlenbrock]: https://gist.github.com/uhlenbrock/1477596
[keighl]: https://gist.github.com/keighl/4338134

## Contributing

Pull requests welcome: fork, make a topic branch, commit (squash when possible) *with tests* and I'll happily consider.

## Copyright

Copyright (c) 2019 Steve Agalloco / Tom Caflisch. See [LICENSE](LICENSE.md) for detail