capistrano-sbt
a capistrano recipe to deploy sbt based projects.
Installation
Add this line to your application's Gemfile:
gem 'capistrano-sbt'
And then execute:
$ bundle
Or install it yourself as:
$ gem install capistrano-sbt
Usage
This recipes will try to do following things during Capistrano deploy:setup
and deploy
tasks.
- Download and install sbt for current project
- Prepare optional
*.sbt
for current project (optional) - Build sbt project remotely (default) or locally
To build you sbt projects during Capistrano deploy
tasks, add following in you config/deploy.rb
. By default, sbt build will run after the Capistrano's deploy:finalize_update
.
# config/deploy.rb
require "capistrano-sbt"
Following options are available to manage your sbt build.
-
:sbt_use_extras
- Use sbt-extras to manage sbt.true
by default. -
:sbt_extras_url
- The download url of sbt-extras. -
:sbt_version
- If:sbt_use_extras
was set asfalse
, download specified version ofsbt-launch.jar
and set it up assbt
. If no version was given, try loading version fromproject/build.properties
. -
:sbt_setup_remotely
- Setupsbt
on remote servers. As same value as:sbt_update_remotely
by default. -
:sbt_setup_locally
- Setupsbt
on local server. Asa same value as:sbt_update_locally
by default. -
:sbt_update_remotely
- Runsbt
on remote servers.true
by default. -
:sbt_update_locally
- Runsbt
on local server.false
by default. -
:sbt_goals
- Thesbt
commands and tasks to be be executed. Runreload clean package
by default. -
:sbt_project_path
- The project path to be built on remote servers. -
:sbt_project_path_local
- The project path to be built on local server. -
:sbt_settings
- List of optional*.sbt
files for remote servers. -
:sbt_settings_local
- List of optional*.sbt
files for local server. -
:sbt_template_path
- The local path where the templates of*.sbt
are in. By default, searches fromconfig/templates
. -
:sbt_settings_path
- The destination path of the optional*.sbt
files. -
:sbt_settings_path_local
- The destination path of the optional*.sbt
files. -
:sbt_java_home
- OptionalJAVA_HOME
settings forsbt
on remote servers. -
:sbt_java_home_local
- OptionalJAVA_HOME
settings forsbt
on local server. -
:sbt_log_noformat
- Do not colorizesbt
outputs.true
by default. -
:sbt_release_build
- Skip building on SNAPSHOT version.false
by default.
Contributing
- Fork it
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Added some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create new Pull Request
Author
- YAMASHITA Yuu (https://github.com/yyuu)
- Geisha Tokyo Entertainment Inc. (http://www.geishatokyo.com/)
License
MIT