Translation(s): none


Building with gem2deb

Note: Always verify the command has finished successfully and make sure there is no error before proceeding to next command.

Setup your environment

Add the following variables in your ~/.bashrc file. DEBEMAIL and DEBFULLNAME variables are used by debian tools to set your name and email.

export DEBEMAIL=your@email.domain
export DEBFULLNAME='Your Name'
alias lintian='lintian -iIEcv --pedantic --color auto'
alias git-import-dsc='git-import-dsc --author-is-committer --pristine-tar'
alias clean='fakeroot debian/rules clean'

Note: You can also use debclean command instead of setting alias for clean.

and update your current environment by running

$ source ~/.bashrc

Build the package

First you need install gem2deb

apt-get install gem2deb

Create a build directory and go there

mkdir -p ~/Build/ruby-packaging && cd $_

gem2deb devise

will run "gem fetch devise" to download the package.

  1. If you get an error that the Test failed, see ruby tests for hints to solve it.

  2. If you see "unmet build dependencies" error, install the build dependencies. Install the build dependencies using apt and not using gem install.

Note: To fetch rails-assets-* gems, you need to provide a different gem source like this example

If initial build failed and .dsc file was not created, you can create it from the package directory (ruby-<foo-version>).

dpkg-source -b .

Once you have the .dsc file, create a git repo from the source package (.dsc, .orig.tar.* and .debian.tar.*)

gbp import-dsc --pristine-tar ruby-devise_<version>.dsc
cd ruby-devise
git tag -d debian/<version> # because the package is not ready yet

Now you have to edit files inside debian subdirectory like

You will find such info at

Note: Read http://www.debian.org/doc/manuals/maint-guide/dreq.en.html to learn more about each file.

Once that is done build the package with

dpkg-buildpackage

If you get an error that it could not be signed, ignore it for now.

And when it has finished check for lintian errors:

lintian

If you get errors, you have to correct them. Then run dpkg-buildpackage again and test with lintian again.

Make sure all copyright notices are added to debian/copyright file by running the following command. If it shows any mismatch, fix them by adding the missing copyright notices to debian/copyright. Note: You'll have to install license-reconcile package first.

license-reconcile

Note: There are two variants of MIT licenses (Expat or X11), use Expat when the text matches with that of license used in Expat project. See https://opensource.stackexchange.com/questions/8585/what-is-the-different-between-mit-and-x11-license-should-the-open-source-packag

Filing ITP bug

ITP stands for Intend to Package or telling the debian community that you are working on creating a new debian package for this software. See Teams/Ruby/Packaging/ITP for the steps.

Source Only Uploads

If your package got accepted in the archive (cleared NEW queue), you will need a SourceOnlyUpload to allow it to migrate to debian testing from debian unstable.

Rails engines

If your package has a app/assets or vendor/assets (if the gem name starts with rails-assets or ends at rails) then your package is very likely to be a rails engine. More about rails engines and Teams/Ruby/Packaging/RailsEngines has current recommended practices for packaging a rails engine.

The following steps are deprecated, add export DH_RUBY = --gem-install in debian/rules at the top instead

1 Install app or vendor in /usr/share/<package name> using debian/install

2 Set rails engine root with quilt to /usr/share/<package name>. Look for 'class Engine < ::Rails::Engine' in lib/<gem name>.rb or lib/<gem name>/engine.rb and add config.root = '/usr/share/<package name>' like this

 if defined?(Rails)
    class Engine < ::Rails::Engine
      # Rails -> use app/assets directory.
      config.root = '/usr/share/ruby-rails-assets-jquery.slimscroll'
    end
  end

3 Add a smoke test like this

Javascripts should be packaged as libjs-<js library name> if it is not packaged already (create a new binary package in debian/control and add 'Section: web' and create libjs-<js library name>.install).

Declare dependency on libjs-<js library name> and create a <package name>.links file.

Refer to ruby-rails-assets-favico.js package for an example.