glyph-fr / capistrano-dotenv-tasks Goto Github PK

View Code? Open in Web Editor NEW

21.0 6.0 7.0 25 KB

Capistrano tasks to manage your .env config files on your remote hosts

License: MIT License

Ruby 100.00%

capistrano-dotenv-tasks's Introduction

Capistrano::Dotenv::Tasks

Show, set and delete env vars in your .env remote file with Capistrano 3.

Installation

Add these lines to your application's Gemfile:

gem 'dotenv'  # if you haven't added it, already
gem 'capistrano-dotenv-tasks', require: false

And then execute:

$ bundle

Or install it yourself as:

$ gem install capistrano-dotenv-tasks

Usage

Require it in your Capfile:

require 'capistrano/dotenv/tasks'

Make the .env file a file that is shared between releases by adding one of the following lines to your config/deploy.rb script:

append :linked_files, '.env'  # for capistrano >= 3.5
set :linked_files, fetch(:linked_file, []).push('.env')  # for capistrano < 3.5

Then, access the capistrano rake tasks to edit your remote .env file from the cap command.

Show your config

$ cap production config:show

Set (create or update) a variable

$ cap production config:set VARNAME=value

Remove a variable

$ cap production config:remove[VARNAME]

Or multiple at once:

$ cap production config:remove[VARNAME1,VARNAME2]

Contributing

Fork it ( https://github.com/glyph-fr/capistrano-dotenv-tasks/fork )
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create a new Pull Request

License

MIT

capistrano-dotenv-tasks's People

Contributors

Stargazers

Watchers

Forkers

mikz 3scale levelinteractive roydq heironimus marcoadkins

capistrano-dotenv-tasks's Issues

Add git tags to repository

It is common practice to add the released versions as tags to git repository. This also makes it easier to see if the latest features in the source are released or not.

Quoted values get unquoted when a separate value is added and sorted

Some values require quotes, particularly if they are long or have special characters in them. These quotes are removed when a new, different key is added. https://github.com/glyph-fr/capistrano-dotenv-tasks/blob/master/lib/capistrano/dotenv/config.rb#L20

Add a way to implement restart after setting config

Could be nice to have a way to implement/override a callback to force server restart after config update.

In my case, I need to cap unicorn:stop and cap unicorn:start after using cap config:set command.

undefined method 'set' for main:Object (NoMethodError)

I just installed this gem and the cap tasks are working perfectly, but my rails generator is broken. I'm getting this message:

/Users/andrew/.rvm/gems/ruby-2.2.4/gems/capistrano-dotenv-tasks-0.1.2/lib/capistrano/dotenv/tasks.rb:6:in `<top (required)>': undefined method `set' for main:Object (NoMethodError)
    from /Users/andrew/.rvm/gems/ruby-2.2.4/gems/bundler-1.11.2/lib/bundler/runtime.rb:91:in `require'
    from /Users/andrew/.rvm/gems/ruby-2.2.4/gems/bundler-1.11.2/lib/bundler/runtime.rb:91:in `rescue in block in require'
    from /Users/andrew/.rvm/gems/ruby-2.2.4/gems/bundler-1.11.2/lib/bundler/runtime.rb:68:in `block in require'
    from /Users/andrew/.rvm/gems/ruby-2.2.4/gems/bundler-1.11.2/lib/bundler/runtime.rb:61:in `each'
    from /Users/andrew/.rvm/gems/ruby-2.2.4/gems/bundler-1.11.2/lib/bundler/runtime.rb:61:in `require'
    from /Users/andrew/.rvm/gems/ruby-2.2.4/gems/bundler-1.11.2/lib/bundler.rb:99:in `require'
    from /Users/andrew/Development/ilf-cms/config/application.rb:7:in `<top (required)>'
    from /Users/andrew/.rvm/gems/ruby-2.2.4/gems/spring-1.6.2/lib/spring/application.rb:82:in `require'
    from /Users/andrew/.rvm/gems/ruby-2.2.4/gems/spring-1.6.2/lib/spring/application.rb:82:in `preload'
    from /Users/andrew/.rvm/gems/ruby-2.2.4/gems/spring-1.6.2/lib/spring/application.rb:143:in `serve'
    from /Users/andrew/.rvm/gems/ruby-2.2.4/gems/spring-1.6.2/lib/spring/application.rb:131:in `block in run'
    from /Users/andrew/.rvm/gems/ruby-2.2.4/gems/spring-1.6.2/lib/spring/application.rb:125:in `loop'
    from /Users/andrew/.rvm/gems/ruby-2.2.4/gems/spring-1.6.2/lib/spring/application.rb:125:in `run'
    from /Users/andrew/.rvm/gems/ruby-2.2.4/gems/spring-1.6.2/lib/spring/application/boot.rb:18:in `<top (required)>'
    from /Users/andrew/.rvm/rubies/ruby-2.2.4/lib/ruby/site_ruby/2.2.0/rubygems/core_ext/kernel_require.rb:54:in `require'
    from /Users/andrew/.rvm/rubies/ruby-2.2.4/lib/ruby/site_ruby/2.2.0/rubygems/core_ext/kernel_require.rb:54:in `require'
    from -e:1:in `<main>'

issue on loading

Hello) it's appear when I try start server

.rvm/gems/ruby-2.3.1@kcs/gems/capistrano-dotenv-tasks-0.1.3/lib/capistrano/dotenv/tasks.rb:6:in `<top (required)>': undefined method `set' for main:Object (NoMethodError)
Did you mean?  send

Values of env variables wrong after update/add operations

I tried to use this gem(newest version) but when I update one variable or add one. The values that were key=value become key="value" and the quotes might break something. Which was my case.

I didn't tested to change but it might be necessary only to change this line https://github.com/glyph-fr/capistrano-dotenv-tasks/blob/master/lib/capistrano/dotenv/config.rb#L23

I will try to fix later when I have the time to test it out. If someone else can test, go for it