Differences between revisions 14 and 55 (spanning 41 versions)
Revision 14 as of 2010-10-11 17:35:50
Size: 4127
Comment:
Revision 55 as of 2021-06-19 14:38:31
Size: 5558
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
= The Debian/Ruby Teams = <<TableOfContents>>
Line 3: Line 3:
The Debian/Ruby teams maintain the Ruby interpreters, libraries and applications. There are actually two different Ruby teams in Debian:
 * the pkg-ruby team maintains the interpreter
 * the pkg-ruby-extras team maintains libraries and applications
= General Information =
Line 7: Line 5:
Most discussions happen on the [[http://lists.debian.org/debian-ruby/| debian-ruby mailing list]]. Discussions specific to pkg-ruby-extras also happen on the [[http://lists.alioth.debian.org/mailman/listinfo/pkg-ruby-extras-maintainers | pkg-ruby-extras-maintainers list]]. You should be subscribed to both if you want to follow Ruby in Debian. The '''Debian Ruby team''' maintains Ruby software in Debian. This includes the interpreters, libraries and applications. All packages are now hosted in the ruby-team group on [[https://salsa.debian.org/ruby-team|Salsa]].
Line 9: Line 7:
We also use IRC (#debian-ruby on irc.debian.org) quite a lot. The complete information is spread across this page and the following pages:
[[/Packaging]] [[/Packaging/Conventions]] [[/Packaging/TestFailures]] [[/Packaging/Tests ]]
Line 11: Line 10:
== pkg-ruby == == Packages information ==
 * [[http://qa.debian.org/developer.php?login=pkg-ruby-extras-maintainers%40lists.alioth.debian.org&comaint=yes|Packages overview]]
 * [[http://pet.debian.net/pkg-ruby-extras/pet.cgi|PET overview for packages in Git]]
 * [[http://udd.debian.org/dmd.cgi?email1=pkg-ruby-extras-maintainers%40lists.alioth.debian.org|Debian Maintainer Dashboard for the team]]
 * [[https://salsa.debian.org/ruby-team|list of all Git repositories owned by the pkg-ruby-extras team]]
 * [[https://bugs.debian.org/cgi-bin/pkgreport.cgi?dist=unstable;maint=pkg-ruby-extras-maintainers%40lists.alioth.debian.org|bugs reported on packages maitained by the team]]
Line 13: Line 17:
 * '''Alioth Project''': http://alioth.debian.org/projects/pkg-ruby
 * '''Subversion repository''': svn://svn.debian.org/pkg-ruby/ (svn client), http://svn.debian.org/wsvn/pkg-ruby/ (browser)
= Joining the Debian Ruby team =
Line 16: Line 19:
How you can help:
 * <<Icon(star_on.png)>> Subscribe to the pkg-ruby packages (ruby1.8, ruby1.9.1, ruby-defaults) on the Packages Tracking System, and then contribute to the bug mail you get. (It is a good idea to also subscribe to bugmail from Ubuntu, see [[http://www.debian.org/doc/developers-reference/resources.html#pts-commands developers reference]] for details).
 * <<Icon(star_on.png)>> Go through bugs, see if you can reproduce them and provide more information. Report them upstream when needed.
 * <<Icon(star_on.png)>><<Icon(star_on.png)>> Checkout the SVN repository, see if you can provide a patch for some issues.
== Communication ==
=== Mailing List ===
The general discussion mailing list of Debian Ruby team can be found at https://lists.debian.org/debian-ruby/ . The mailing list is open for anybody to join and post and acts as the central point of access for communication with the Team. To post to the mailing list, send a mail to debian-ruby@lists.debian.org
Line 21: Line 23:
== pkg-ruby-extras == === IRC ===
   * #debian-ruby on irc.debian.org (OFTC) where team members hang around.
   * #debian-ruby-changes on irc.debian.org (OFTC) for [[Services/KGB|KGB]] notifications.
Line 23: Line 27:
 * '''Team Documentation''': [[/RubyExtras]]. In particular, see the [[/RubyExtras/JoiningTheTeam|Joining the Team]] page.
 * '''Alioth Project''': http://alioth.debian.org/projects/pkg-ruby-extras
 * '''Subversion repository''': svn://svn.debian.org/pkg-ruby-extras/ (svn client), http://svn.debian.org/wsvn/pkg-ruby-extras/ (browser)
 * [[http://qa.debian.org/developer.php?login=pkg-ruby-extras-maintainers%40lists.alioth.debian.org&comaint=yes|Packages overview]]
 * [[http://pkg-ruby-extras.alioth.debian.org/cgi-bin/pet.cgi|PET overview]]
How you can help:
 * <<Icon(star_on.png)>> Subscribe to the lists, and start contributing to solving bugs.
 * <<Icon(star_on.png)>> Use the Packages overview to go through all existing bugs, and see if you can help with solving some of them.
 * <<Icon(star_on.png)>><<Icon(star_on.png)>> Checkout the SVN repository, and see if you can improve the existing packages. There are many things that can be improved!
== Salsa ==
This is the server hosting all git repositories maintained by the [[https://salsa.debian.org/ruby-team|ruby-team]].
The repositories are all public.
You can send merge requests for one-shot fixes.
You can also request membership to the group `ruby-team` and wait for an admin to add you to the group.
To speed up the procedure, send an email to the mailing list (debian-ruby@lists.debian.org) stating your request to join the alioth group and preferably the package you intend to maintain under the team.
Line 33: Line 34:
== Mid- and Long-term tasks == Information about the transition from Alioth to Salsa can be found [[/Salsa|here]].
Line 35: Line 36:
=== Backports ===
<<Icon(star_on.png)>>
Provide backports for the key Ruby packages (interpreter, rubygems) for both Debian and Ubuntu stable releases.
= Contributing to the Debian Ruby team =
Line 39: Line 38:
=== Revamp the libraries packaging helper ===
<<Icon(star_on.png)>><<Icon(star_on.png)>><<Icon(star_on.png)>><<Icon(star_on.png)>>
Our current approach is based on cdbs, and duplicates a lot of code between binary packages when we provide both 1.8 and 1.9.X packages. It would be much better if we only had one package when the library works with both.
Also, we need somehow to work with rubygems (this is a bit too hard currently). The approach could be:
 * have a [[gem2tgz]] script that generates a clean tarball as a basis for packaging work.
 * have a dh-make-ruby script that converts the tarball into a Debian source package, using the gem metadata as a basis
 * have a dh_ruby helper that would handle installing with either a modified setup.rb or a modified extconf.rb, run tests, etc.
Many things need to be well thought, like how to handle dependencies. Which makes this task quite hard to approach.
If you are a Debian enthusiast with basic Ruby knowledge, you can help Debian Ruby team's activities. There are different ways to contribute to Debian Ruby team, which includes (and is not limited to)
Line 48: Line 40:
=== Use the alternatives system ===
<<Icon(star_on.png)>><<Icon(star_on.png)>><<Icon(star_on.png)>>
The alternatives system would allow to easily switch between Ruby 1.8 and Ruby 1.9.X (instead of the current "/usr/bin/ruby is a symlink to ruby1.8" approach). However, this requires rethinking how we package Ruby applications and libraries, to make sure that those that only work with one particular Ruby version will be correctly treated. We cannot just break them all.
== Identifying and reporting bugs ==

If you are a user of the packages maintained by Debian Ruby team, you can help us by reporting the bugs you find in the packages using the [[http://bugs.debian.org|Debian Bug Tracker]] or [[https://wiki.debian.org/reportbug|reportbug]] tool. You can also add wishlist bugs about changes/features you would like to be added to the package so as to make it better to use.

== Bug triaging ==

You can also help to triage bugs, by choosing bugs from https://bugs.debian.org/pkg-ruby-extras-maintainers@lists.alioth.debian.org or https://udd.debian.org/dmd/?email1=pkg-ruby-extras-maintainers%40lists.alioth.debian.org&email2=&email3=&packages=&ignpackages=&format=html#todo, and try to
 1. reproduce them on your local machine / clean chroot as needed
 2. confirm bug's existence and validity
 3. Tag bugs appropriately
 4. Close invalid ones

== Fixing bugs ==

If you have knowledge in Ruby, you can fix bugs that have been filed against the team maintained packages by providing patches and helpful information. Those like FTBFS bugs are often caused by test failures in packages and should be fixed to ensure reproducibility of the packages.

Chances of bugs are more during transition of the Ruby version and any help in identifying, tagging and fixing them are much appreciated.

== Documentation ==

This wiki, and it's subpages are intended to collect all the information regarding the structure, activities and conventions of Debian Ruby team, and needs extensive care and help to be maintained in good, up-to-date state. Start by [[https://wiki.debian.org/FrontPage?action=newaccount|creating an account]] in Debian Wiki and cleaning up the pages to contain only valid, prompt and updated information

== Packaging ==

'''Workflow about packaging new Ruby based software for Debian can be found [[/Packaging|here]].'''

== Maintaining ==

Maintainance of a package involves the tasks like updating a package to the latest version, keeping the package to be in accordance with the current Debian policies and standards etc. To know about updating a package and uploading it, visit here.

== Historical Section ==

Libraries and applications were previously maintained inside the
[[https://alioth.debian.org/projects/pkg-ruby-extras/|pkg-ruby-extras project]]
on Alioth, while the interpreter packages were maintained inside of the
[[https://alioth.debian.org/projects/collab-maint/|collab-maint project]].
These locations are now deprecated.

= Miscellaneous Documentation =
 * [[/InterpreterTransitions | Interpreter Transition Mechanism]] - Steps to follow on updating the version of Ruby interpreters in Debian archives.
 * '''[[/Packaging|Team Documentation and current packaging practices]]'''.
 * Information for upstream developers: [[/RubyExtras/UpstreamDevelopers]], [[/RubyExtras/OnRubygems]]

= Sub Pages =
Sub pages of this documentation can be found below:
<<Navigation(children,30)>>

General Information

The Debian Ruby team maintains Ruby software in Debian. This includes the interpreters, libraries and applications. All packages are now hosted in the ruby-team group on Salsa.

The complete information is spread across this page and the following pages: /Packaging /Packaging/Conventions ?/Packaging/TestFailures /Packaging/Tests

Packages information

Joining the Debian Ruby team

Communication

Mailing List

The general discussion mailing list of Debian Ruby team can be found at https://lists.debian.org/debian-ruby/ . The mailing list is open for anybody to join and post and acts as the central point of access for communication with the Team. To post to the mailing list, send a mail to debian-ruby@lists.debian.org

IRC

  • #debian-ruby on irc.debian.org (OFTC) where team members hang around.
  • #debian-ruby-changes on irc.debian.org (OFTC) for KGB notifications.

Salsa

This is the server hosting all git repositories maintained by the ruby-team. The repositories are all public. You can send merge requests for one-shot fixes. You can also request membership to the group ruby-team and wait for an admin to add you to the group. To speed up the procedure, send an email to the mailing list (debian-ruby@lists.debian.org) stating your request to join the alioth group and preferably the package you intend to maintain under the team.

Information about the transition from Alioth to Salsa can be found here.

Contributing to the Debian Ruby team

If you are a Debian enthusiast with basic Ruby knowledge, you can help Debian Ruby team's activities. There are different ways to contribute to Debian Ruby team, which includes (and is not limited to)

Identifying and reporting bugs

If you are a user of the packages maintained by Debian Ruby team, you can help us by reporting the bugs you find in the packages using the Debian Bug Tracker or reportbug tool. You can also add wishlist bugs about changes/features you would like to be added to the package so as to make it better to use.

Bug triaging

You can also help to triage bugs, by choosing bugs from https://bugs.debian.org/pkg-ruby-extras-maintainers@lists.alioth.debian.org or https://udd.debian.org/dmd/?email1=pkg-ruby-extras-maintainers%40lists.alioth.debian.org&email2=&email3=&packages=&ignpackages=&format=html#todo, and try to

  1. reproduce them on your local machine / clean chroot as needed
  2. confirm bug's existence and validity
  3. Tag bugs appropriately
  4. Close invalid ones

Fixing bugs

If you have knowledge in Ruby, you can fix bugs that have been filed against the team maintained packages by providing patches and helpful information. Those like FTBFS bugs are often caused by test failures in packages and should be fixed to ensure reproducibility of the packages.

Chances of bugs are more during transition of the Ruby version and any help in identifying, tagging and fixing them are much appreciated.

Documentation

This wiki, and it's subpages are intended to collect all the information regarding the structure, activities and conventions of Debian Ruby team, and needs extensive care and help to be maintained in good, up-to-date state. Start by creating an account in Debian Wiki and cleaning up the pages to contain only valid, prompt and updated information

Packaging

Workflow about packaging new Ruby based software for Debian can be found here.

Maintaining

Maintainance of a package involves the tasks like updating a package to the latest version, keeping the package to be in accordance with the current Debian policies and standards etc. To know about updating a package and uploading it, visit here.

Historical Section

Libraries and applications were previously maintained inside the pkg-ruby-extras project on Alioth, while the interpreter packages were maintained inside of the collab-maint project. These locations are now deprecated.

Miscellaneous Documentation

Sub Pages

Sub pages of this documentation can be found below: