rake-compiler-dock
Easy to use and reliable cross compiler environment for building Windows binary gems.
It provides cross compilers and Ruby environments for all versions of the RubyInstaller . They are prepared for use with rake-compiler .
This is kind of successor of rake-compiler-dev-box. It is wrapped as a gem for easier setup, usage and integration and is based on lightweight Docker containers. It is also more reliable, since the underlying docker images are versioned and kept unchanged while building.
Installation
Install docker natively on Linux:
$ sudo apt-get install docker.io
... or install boot2docker on Windows or OS X .
Install rake-compiler-dock as a gem. The docker image is downloaded later on demand:
$ gem install rake-compiler-dock
... or build your own gem and docker image:
$ git clone https://github.com/larskanis/rake-compiler-dock
$ rake install
Usage
Rake-compiler-dock offers the shell command rake-compiler-dock
and a ruby API for issuing commands within the docker image, described below.
rake-compiler-dock
without arguments starts an interactive shell session.
This is best suited to try out and debug a build.
It mounts the current working directory into the docker environment.
All changes below the current working directory are shared with the host.
But note, that all other changes to the file system of the container are dropped at the end of the session - the docker image is static for a given version. rake-compiler-dock
can also take the build command(s) from STDIN or as command arguments.
All commands are executed with the same user and group of the host. This is done by copying user account data into the container and sudo to it.
To build x86- and x64 Windows (RubyInstaller) binary gems interactively, it can be called like this:
user@host:$ cd your-gem-dir/
user@host:$ rake-compiler-dock # this enters a container with an interactive shell
user@5b53794ada92:$ bundle
user@5b53794ada92:$ rake cross native gem
user@5b53794ada92:$ exit
user@host:$ ls pkg/*.gem
your-gem-1.0.0.gem your-gem-1.0.0-x64-mingw32.gem your-gem-1.0.0-x86-mingw32.gem
Or non-interactive:
user@host:$ rake-compiler-dock bash -c "bundle && rake cross native gem"
The environment variable RUBY_CC_VERSION
is predefined as described below.
If necessary, additional software from the Ubuntu repositories can be installed, prior to the build command. This is local to the running session, only:
sudo apt-get update && sudo apt-get install your-package
You can also choose between different executable ruby versions by rvm use <version>
.
Current default is 2.2.
Add to your Rakefile
To make the build process reproduceable for other parties, it is recommended to add rake-compiler-dock to your Rakefile. This can be done like this:
task 'gem:windows' do
require 'rake_compiler_dock'
RakeCompilerDock.sh "bundle && rake cross native gem"
end
Rake-compiler-dock uses semantic versioning, so you should add it into your Gemfile, to make sure, that future changes will not break your build.
gem 'rake-compiler-dock', '~> 0.4.0'
See the wiki for projects which make use of rake-compiler-dock.
Environment Variables
Rake-compiler-dock makes use of several environment variables.
The following variables are recognized by rake-compiler-dock:
RCD_IMAGE
- The docker image that is downloaded and started. Defaults to "larskanis/rake-compiler-dock:IMAGE_VERSION" with an image version that is determined by the gem version.
The following variables are passed through to the docker container without modification:
http_proxy
,https_proxy
,ftp_proxy
- See Frequently asked questions for more details.
The following variables are provided to the running docker container:
RCD_IMAGE
- The full docker image name the container is running on.RCD_HOST_RUBY_PLATFORM
- TheRUBY_PLATFORM
of the host ruby.RCD_HOST_RUBY_VERSION
- TheRUBY_VERSION
of the host ruby.RUBY_CC_VERSION
- The target ruby versions for rake-compiler. The default is defined in the Dockerfile, but can be changed as a parameter to rake.
Other environment variables can be set or passed through to the container like this:
RakeCompilerDock.sh "rake cross native gem OPENSSL_VERSION=#{ENV['OPENSSL_VERSION']}"
More information
See Frequently asked questions and
Contributing
- Fork it ( https://github.com/larskanis/rake-compiler-dock/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