| 1 |
gemwatch - Watch rubygems.org and download gems converted to tarballs
|
| 2 |
=====================================================================
|
| 3 |
|
| 4 |
Introduction
|
| 5 |
------------
|
| 6 |
|
| 7 |
gemwatch was designed to help Debian developers in tracking Ruby software
|
| 8 |
released only as rubygems, and to convert them into a format that is (more)
|
| 9 |
suitable for packaging according to the needs of Debian developers.
|
| 10 |
|
| 11 |
Please see the following pages for more information, specially about why this
|
| 12 |
is needed:
|
| 13 |
|
| 14 |
* http://pkg-ruby-extras.alioth.debian.org/rubygems.html
|
| 15 |
* http://pkg-ruby-extras.alioth.debian.org/upstream-devs.html
|
| 16 |
|
| 17 |
There is a lot of Ruby developers that only release software as gems on
|
| 18 |
http://rubygems.org/. gemwatch is an application to circumvent this practice:
|
| 19 |
it provides Debian developers with a tool to follow the releases done in
|
| 20 |
rubygems.org, and automatically converts ``.gem`` packages into ``.tar.gz``
|
| 21 |
ones as expected for proper packaging work.
|
| 22 |
|
| 23 |
Usage in Debian watch files
|
| 24 |
---------------------------
|
| 25 |
|
| 26 |
Debian package maintainers can use the following syntax in their watch files to
|
| 27 |
be properly warned of new upstream releases::
|
| 28 |
|
| 29 |
version=3
|
| 30 |
http://gemwatch.heroku.com/${gem} /download/${gem}-(.*)\.tar\.gz
|
| 31 |
|
| 32 |
Gem conversion to tarball
|
| 33 |
-------------------------
|
| 34 |
|
| 35 |
A gem named ``mygem-0.1.0.gem`` is converted in a tarball with the following
|
| 36 |
steps::
|
| 37 |
|
| 38 |
mkdir mygem-0.1.0
|
| 39 |
cd mygem-0.1.0
|
| 40 |
wget ...../mygem-0.1.0.gem
|
| 41 |
tar xfm mygem-0.1.0.gem
|
| 42 |
tar xzfm data.tar.gz
|
| 43 |
xcat metadata.gz > metadata.yml
|
| 44 |
rm -f mygem-0.1.0.gem data.tar.gz metadata.gz
|
| 45 |
cd ..
|
| 46 |
tar czf mygem-0.1.0.tar.gz mygem-0.1.0
|
| 47 |
|
| 48 |
This way:
|
| 49 |
|
| 50 |
* The tarball contains all the files the gem contains
|
| 51 |
* The gem metadata ends up in a file named ``metadata.yml`` inside the tarball
|
| 52 |
|
| 53 |
Running as CGI
|
| 54 |
--------------
|
| 55 |
|
| 56 |
* Create a symlink pointing to the ``cgi`` script into your ``cgi-bin`` directory. The symlink can be named as you wish.
|
| 57 |
* Make sure gemwatch's ``public`` directory is accessible as ``/gemwatch``
|
| 58 |
* Example:
|
| 59 |
** ``http://mysite.com/cgi-bin/gemwatch``, where ``gemwatch`` is a symlink to gemwatch's ``cgi`` script
|
| 60 |
** ``http://mysite.com/gemwatch`` is a symlink (or an alias) to gemwatch's ``public`` directory.
|
| 61 |
|
| 62 |
Deploying to alioth
|
| 63 |
-------------------
|
| 64 |
|
| 65 |
To deploy gemwatch to alioth, it is sufficient to run ``rake alioth`` under
|
| 66 |
gemwatch root directory (the one containing the Rakefile).
|
| 67 |
|
| 68 |
License
|
| 69 |
-------
|
| 70 |
|
| 71 |
Copyright © 2010, Antonio Terceiro <terceiro@softwarelivre.org> and the Debian
|
| 72 |
pkg-ruby-extras team <http://pkg-ruby-extras.alioth.debian.org/>.
|
| 73 |
|
| 74 |
This program is free software: you can redistribute it and/or modify
|
| 75 |
it under the terms of the GNU Affero General Public License as published by
|
| 76 |
the Free Software Foundation, either version 3 of the License, or
|
| 77 |
(at your option) any later version.
|
| 78 |
|
| 79 |
This program is distributed in the hope that it will be useful,
|
| 80 |
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
| 81 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
| 82 |
GNU Affero General Public License for more details.
|
| 83 |
|
| 84 |
You should have received a copy of the GNU Affero General Public License
|
| 85 |
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
Parent Directory
| 
Revision Log