[DRE-maint] RFC for first package: ruby-filepath

[Cédric Boutillier]

Hi Gioele,

Please use debian-ruby at lists.debian.org for such requests. The lists on
alioth receive mainly automatic messages.

On Sat, Sep 21, 2013 at 07:57:55PM +0200, Gioele Barabucci wrote:
> Hello,

> I have been working on my very first proper debian package for a
> Ruby gem. ITP:
> http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=723905

> I think the package is almost ready. Could someone have a look at
> the "working directory" that I uploaded to github

>     https://github.com/gioele/test-debian-gem-packaging

> The repo history documents all the steps I have taken from the
> initial dh-make-ruby.

> I tested building the package from the source with pbuilder. The
> package is lintian-free except for the lack of upstream changelog
> file and the NMU warnings.

> Any comment is welcome.

I had a quick look at your repository. Here are a few comments.

- Git repositories of the team have 3 branches: upstream (tracking files
  from upstream), pristine-tar (used to reconstruct the tarballs) and
  master (upstream + debian/ directory). Your repo has only a master
  branch.
  A way to create the three branches is to import the initial source
  package created by gem2deb in a Git repo with:

  gbp import-dsc --pristine-tar yourpackage_version-1.dsc

- We usually do not store the .pc directory in Git since it is modified
  when poping/pushing patches. We also keep the repositories with
  patches unapplied, so that upstream files are unmodified in the master
  branch.

- We usually do not use bundler as a build dependency. Instead, we patch
  the source to require explicitely all gems indicated in Gemfile. Here
  you can simply drop bundler (it is only required in the Rakefile,
  which is not used to build the package).

- debian/control:
  - you'll need to uncomment the Vcs-* fields when you import your
    package in the team repository.
  - I would shorten the short description and drop the part after ";".
    The short description should start with a small 's'.
    Maybe indicate in the long description that FilePath is a modern
    replacement for Pathname. The name of the class is missing a capital
    P in the long description.
  - you get an NMU warning with lintian because you mispelled your name
    in the uploaders field (i missing at the end).

- debian/copyright:
  I think that even if you choose CC0, you should indicate your name in
  the Copyright: field as the rights holder/"Affirmer" of the license.
  You need to include the full text of the CC0 license in a dedicated
  License: paragraph (source your COPYING file at the end of copyright),
  replace emty lines with a line with a single dot, and indent with a
  single space, add a License: CC0 header.

- tests: currently, they aren't run. RSpec specs need rspec/autorun if
  the ruby-test-files.yaml method is used. however, you need also to
  call spec/task.rb. You need to replace it by a ruby-test.rake file
  like

  require 'rspec/core/rake_task'
  require File.join(File.dirname(__FILE__), '../spec/tasks')

  RSpec::Core::RakeTask.new(:spec)

  task :default => :spec
  task :spec => 'spec:fixtures:gen'

  I get one spec failing when running with dpkg-buildpackage
  (./spec/filepath_spec.rb:575), but not with rake -f debian/ruby-tests.rake.

- you need to remove spec/fixtures by adding a override_dh_clean in the
  debian/rules files, doing dh_clean and rm -rf spec/fixtures

- debian/ruby-filepath.docs
  it contains boilerplate text. Delete the first line and uncomment the
  second.

- debian/changelog: set the suite from UNRELEASED to unstable when
  ready.

I hope it will allow you to go further.

Cheers,

Cédric
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 836 bytes
Desc: Digital signature
URL: <http://lists.alioth.debian.org/pipermail/pkg-ruby-extras-maintainers/attachments/20130922/738a4c7a/attachment.sig>