REVU

Differences between revisions 30 and 107 (spanning 77 versions)
Revision 30 as of 2006-01-03 20:17:47
Size: 5280
Editor: bur91-2-82-231-159-240
Comment:
Revision 107 as of 2011-12-08 16:58:49
Size: 9398
Editor: allison
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
The preferred path for getting your new package into Ubuntu is to first submit it upstream to Debian. Once it's packaged for Debian, you can then [[SyncRequestProcess|request a sync]] to Ubuntu. This also has the advantage of making your package available to more users. For general instructions on getting your package into Debian, see the [[http://mentors.debian.net/cgi-bin/welcome|Debian mentors page]]. Note that there are many teams in Debian that can offer more focused mentorship. For example, if you have a new Python module you want to get into Debian and Ubuntu, you should begin your journey with the [[http://wiki.debian.org/Teams/PythonModulesTeam|Debian Python Modules Team (DPMT)]]. You can visit the IRC channel #debian-ubuntu on irc.oftc.net to discuss packaging in Debian with Debian and Ubuntu developers.

If your new package is Ubuntu-specific, or for some other reason you can't get your package into Debian first, the second best strategy is to follow the procedure for [[https://wiki.ubuntu.com/UbuntuDevelopment/NewPackages#Going_through_MOTU|submitting a package through MOTU]].

== What is REVU? ==

[[http://revu.ubuntuwire.com/|REVU]] (http://revu.ubuntuwire.com) is a web-based tool which some Ubuntu mentors use as they review new packages. It is no longer actively used by Ubuntu Developers, so you should generally only submit a package there when a mentor specifically requests you to do so.

=== How does REVU work? ===

Packagers can upload their packages to REVU. The packages can then be commented on by reviewers, and the packager can send updates of their package to REVU until it gets advocated by at least 2 [[MOTU]]s. At that point, a MOTU can upload the approved package to Universe.

If you packaged a new upstream version (of a package that is already in the archives), and you want to get it sponsored, do not use REVU to get it sponsored. Instead see SponsorshipProcess.

== Contribute as an Uploader ==

=== Why contribute as an Uploader? ===

If you've built a package of a program that isn't available in the development version of either Ubuntu (currently PrecisePangolin) or Debian (Sid), you can upload it to REVU. It can then be checked over by MOTUs and advocated into Ubuntu's Universe archive.

In order to do this, you need to register as an uploader on the REVU system.

=== Register as a REVU uploader ===

In order to upload to REVU, you will need to have a [[https://launchpad.net|Launchpad]] account and that you have added your [[GPGKey]] to it, [[https://launchpad.net/people/+me/+editpgpkeys|here]].

Then [[http://revu.ubuntuwire.com/launchpad_login.py|log in]] to REVU and it will automatically get your GPG key from Launchpad, which it will then use to recognize your uploads.

{{attachment:IconsPage/important.png}} It is important that you login to REVU at least once before you upload first package. If this is not done then REVU will not have your GPG key imported from Launchpad and the package will get rejected automatically.

=== Upload your packages ===

Uploading to REVU is done with dput.

In distributions starting with Ubuntu 6.06 LTS (Dapper Drake), dput is already configured for REVU uploads, with the [revu] entry. However, if are running an earlier version you can add the following entry to your /etc/dput.cf:
Line 2: Line 38:
 ATTENTION: REVU HAS MOVED! Please update your dput.cf   [revu]
  fqdn = revu.ubuntuwire.com
  incoming = /incoming
  login = anonymous
  progress_indicator = 2
  allow_unsigned_uploads = 0
Line 5: Line 46:
[http://revu.tauware.de/ REVU] is a web-based tool to allow people who have worked on packages a chance to "put their packages out there" for other people to look at and comment on in a structured manner.
Once a packager's PGP Key has been added to the keyring, the packager can begin to upload his packages to REVU. They are then commented by reviewers and the packager can send updates of his package to REVU till it gets advocated by at least 2 MOTUs. When that point is reached, a MOTU uploads the approved package to Universe.
Line 8: Line 47:
This service is experimental at the moment and involves quite some
manual interaction. The service is located at [http://revu.tauware.de].
If you are not an Ubuntu developer, you can set REVU as the default host for dput by modifying the [DEFAULT] section in dput.cf. This way, you don't need to specify what host to use when using dput to upload.
Line 11: Line 49:
{{{
  default_host_main = revu
}}}
Line 12: Line 53:
== Contribute as uploader == ==== Building a package for upload ====
Line 14: Line 55:
=== Why contribute as uploader ? === Uploads to REVU should only be signed source files, with the original tarball. Please do not upload unsigned source or binary packages. The ''allow_unsigned_uploads = 0'' in the ''[revu]'' stanza in dput.cf should be enforcing this anyway.
Line 16: Line 57:
You would like a program to be distributed in Ubuntu, but it's not already available in the development version of either Ubuntu (currently DapperDrake) or Debian (Sid) ?
Then you might package this program and upload it to REVU. In order to do so, you need to register as an uploader on the REVU system.
Inside your package directory, issue
Line 19: Line 59:
{{{
   dpkg-buildpackage -S -sa -rfakeroot
}}}
Line 20: Line 63:
=== Register as uploader === -S builds a source package, and -sa includes the original source. If your GPG key is not configured correctly, add {{{-kGPGKEYID}}} to the command line.
Line 22: Line 65:
What you need : ==== Uploading it ====
Line 24: Line 67:
 * A GPGKey
 * Know how to make Debian packages (see PackagingTips)
 * One or more new packages to upload
Consider going through the [[https://wiki.ubuntu.com/MOTU/Packages/REVU/CheckList|REVU Checklist]] with your package.
Line 28: Line 69:
It is not necessary to GetYourKeySigned, but it is a good idea anyway. Please send a signed email with your GnuPG keyid to keyring@tiber.tauware.de. One of the REVU admins will add you then to the uploaders keyring (== Upload rights for REVU). You don't need a password to upload packages, only to log in to the website and reply to comments. dpkg-buildpackage will output a package-version_source.changes file, which is uploaded with ''dput''.
Line 30: Line 71:
Please note that all uploaders for universe have been added to the REVU keyring! {{{
   dput revu package_version_source.changes
}}}
Line 32: Line 75:
If your firewall requires passive FTP, dput may hang while uploading. In that case, try {{{dput -P package-version_source.changes}}}.
Line 33: Line 77:
=== Howto login === {{attachment:IconsPage/note.png}} If you haven't set REVU as the default host (as explained previously), you need to specify to dput that you wish to use it on the command line: {{{dput revu *_source.changes}}}. The default host is the Ubuntu official repository, and if you are not an Ubuntu developer, your upload to the Ubuntu repository will be rejected.
Line 35: Line 79:
After your first upload, you will be automatically registered to the database and assigned a random password. Use the email address you used in the changelog file of your upload as login and press the 'recover password' link, so as to receive your password by email. If you are reuploading a changed package (after receiving reviews), you may get an error like this:
{{{
  Upload package to host revu
  Already uploaded to ubuntuwire.com
  Doing nothing for myapp_source.changes
}}}
Line 37: Line 86:
To fix, add the -f option to dput to force the upload.

If you aborted an upload in progress, you might get an error like this:
{{{
  Error '553 Could not create file.' during ftp transfer of myapp.dsc
  Note: This problem might be caused by files already existent on the server.
  For the official Debian upload queues, the dcut(1) utility can be used
  to remove stale files from unsuccessful uploads.
}}}

To solve this, just wait 5 minutes. Processing of uploads is done every 5 min. If your upload doesn't show up, please contact the REVU administrators on the IRC channel #ubuntu-motu:

 * Siegfried Gevatter (RainCT)
 * Nathan Handler (nhandler)
 * Emmet Hikory (persia)
 * Jonathan Davies (jpds)
 * Morten Kjeldgaard (mok0)
 * Raphaël Pinson (raphink)
 * Richard Johnson (nixternal)

=== How to log in ===

REVU uses Launchpad's OpenID server. When you click "Login via Launchpad OpenID", you'll be redirected to Launchpad to confirm the login and then redirected back to REVU.
Line 41: Line 113:
However, commenting uploads is only available to registered users. As an uploader, you can only comment your own uploads. This can be useful to give reviewers some infos on the changes you made between two uploads of your packages.
Line 43: Line 114:
However, only registered users can comment. Commenting on your own packages can be useful to give reviewers some info on the changes you have made between two uploads of your packages. You can also review packages from other people, even if you are not a MOTU, if you know for sure that what you write is true.

In order to know if a comment is from a MOTU, look at the icon before his name; if it shows a light bulb, it's from a contributor; if it shows the MOTU emblem, it's from a MOTU, and if it shows a green tick, that does not only mean that it's from a MOTU but also that he advocated the package.
Line 45: Line 119:
(moved from UniverseCandidates)
Line 47: Line 120:
 * you must have reviewed this package for known security vulnerabilities and provide patches for all of them
 * we can refuse the package on the grounds of known security problems and design
 * you must have included a copyright and licence file, and those must allow inclusion of the package in the universe component and on mirrors
 * the package must be known to build on top of the main component of the current ubuntu stable release, it may require other packages already in universe
 * You must have reviewed your package for known security vulnerabilities and provide patches for all of them.
 * We can refuse the package on the grounds of known security problems and design.
 * You must have included a copyright and license file, and those must allow inclusion of the package in the universe component and on mirrors.
 * The package must be known to build on top of the main component of the current Ubuntu stable release; it may require other packages already in universe.
Line 55: Line 128:
If you need help on these steps or if you have more questions about REVU, you can ask on #ubuntu-motu on the Freenode network. If you need help on these steps or if you have more questions about REVU, you can ask in #ubuntu-motu on the Freenode network. 
Line 58: Line 131:
== Contribute as reviewer == === What Next? ===

When your package has two MOTU advocates, it will be uploaded to Ubuntu's New queue. Here it will be reviewed yet again by an Archive Admin. Read more about this on the page [[https://wiki.ubuntu.com/MOTU/Packages/REVUWhatNext|REVUWhatNext]].
Line 61: Line 136:
=== Why contribute as reviewer ? === === Why contribute as Reviewer? ===
Line 63: Line 138:
You have knowledge in packaging and knows policy well? Do you have some experience in packaging and know policy well?
Line 65: Line 140:
Line 69: Line 143:
Line 72: Line 145:
 * A GPGKey
 * Be a ["MOTU"]
 * A [[GPGKey]]
 * Be an [[MOTU]]
Line 75: Line 148:
Please send a signed and encrypted mail with your password and GnuPG keyid to
keyring@tiber.tauware.de. We will mark you as Reviewer in the database.
Please contact one of the REVU administrators (see a list on the [[http://revu.ubuntuwire.com/stats|statistics page]]) on the IRC channel #ubuntu-motu. We will mark you as Reviewer in the database.
Line 78: Line 150:
=== Using REVU-Tools to review on REVU ===
Line 79: Line 152:
=== Howto upload === See [[/REVU-Tools]].
Line 81: Line 154:
Once a package has been advocated by two reviewers on REVU, a MOTU can upload it to the universe repository. === Reviewing Guidelines ===
Line 83: Line 156:
The upload process is similar to uploading to ubuntu, see [:Uploads]. Here is a dput snippet: When reviewing a package that needs work before upload, please summarise as many issues as possible in the REVU comment, so that the Uploader has a larger work list. It can be very frustrating to revise the package for each issue, and Uploaders may wonder if it will ever end.

If you advocate a package, please paste the URL in #ubuntu-motu with a notification of advocation, to encourage someone to upload it.

Tip: You can easily download a source package using the .dsc with dget (package devscripts)
Line 85: Line 162:
  [revu]
  fqdn = revu.tauware.de
  incoming = /incoming
  login = anonymous
dget -ux http://path/to/the/dsc/file
Line 90: Line 164:

Don't forget to adjust your [DEFAULT] section to have an entry like this:
{{{
  default_host_main = revu
}}}

Please do only signed uploads, and please always include the orig tarball. Otherwise reviewers won't be able to look at your extracted source package. When building with dpkg-buildpackage, you can use options "-S -sa -rfakeroot" to build only the source package and also include the original source in the package.

After the package is built, you can use dput with the above config file changes to upload it by specifying just the *_source.changes file that was created, ie. dput *_source.changes. If your firewall requires a passive FTP, dput will seem to hang while uploading. In that case, try "dput -P *_source.changes".

If you are reuploading a changed package (after receiving reviews), you may get an error like this:
{{{
  Upload package to host revu
  Already uploaded to tauware.de
  Doing nothing for myapp_source.changes
}}}
To fix, add the -f option to dput to force the upload.

Processing of uploads is done every 5 min. So, if your upload doesn't show up, please contact siretart@tauware.de or siretart in #ubuntu-motu
Line 112: Line 167:
please use [http://revu.tauware.de/cgi-bin/trac.cgi The revu-Development-Center] for feature requests and bug reports. Please submit feature requests and bug reports to the [[https://launchpad.net/revu|REVU Project]] on Launchpad.
Line 114: Line 169:
["CategoryMOTU"] ----
[[CategoryMOTU]]

The preferred path for getting your new package into Ubuntu is to first submit it upstream to Debian. Once it's packaged for Debian, you can then request a sync to Ubuntu. This also has the advantage of making your package available to more users. For general instructions on getting your package into Debian, see the Debian mentors page. Note that there are many teams in Debian that can offer more focused mentorship. For example, if you have a new Python module you want to get into Debian and Ubuntu, you should begin your journey with the Debian Python Modules Team (DPMT). You can visit the IRC channel #debian-ubuntu on irc.oftc.net to discuss packaging in Debian with Debian and Ubuntu developers.

If your new package is Ubuntu-specific, or for some other reason you can't get your package into Debian first, the second best strategy is to follow the procedure for submitting a package through MOTU.

What is REVU?

REVU (http://revu.ubuntuwire.com) is a web-based tool which some Ubuntu mentors use as they review new packages. It is no longer actively used by Ubuntu Developers, so you should generally only submit a package there when a mentor specifically requests you to do so.

How does REVU work?

Packagers can upload their packages to REVU. The packages can then be commented on by reviewers, and the packager can send updates of their package to REVU until it gets advocated by at least 2 MOTUs. At that point, a MOTU can upload the approved package to Universe.

If you packaged a new upstream version (of a package that is already in the archives), and you want to get it sponsored, do not use REVU to get it sponsored. Instead see SponsorshipProcess.

Contribute as an Uploader

Why contribute as an Uploader?

If you've built a package of a program that isn't available in the development version of either Ubuntu (currently PrecisePangolin) or Debian (Sid), you can upload it to REVU. It can then be checked over by MOTUs and advocated into Ubuntu's Universe archive.

In order to do this, you need to register as an uploader on the REVU system.

Register as a REVU uploader

In order to upload to REVU, you will need to have a Launchpad account and that you have added your GPGKey to it, here.

Then log in to REVU and it will automatically get your GPG key from Launchpad, which it will then use to recognize your uploads.

IconsPage/important.png It is important that you login to REVU at least once before you upload first package. If this is not done then REVU will not have your GPG key imported from Launchpad and the package will get rejected automatically.

Upload your packages

Uploading to REVU is done with dput.

In distributions starting with Ubuntu 6.06 LTS (Dapper Drake), dput is already configured for REVU uploads, with the [revu] entry. However, if are running an earlier version you can add the following entry to your /etc/dput.cf:

  [revu]
  fqdn = revu.ubuntuwire.com
  incoming = /incoming
  login = anonymous
  progress_indicator = 2
  allow_unsigned_uploads = 0

If you are not an Ubuntu developer, you can set REVU as the default host for dput by modifying the [DEFAULT] section in dput.cf. This way, you don't need to specify what host to use when using dput to upload.

  default_host_main = revu

Building a package for upload

Uploads to REVU should only be signed source files, with the original tarball. Please do not upload unsigned source or binary packages. The allow_unsigned_uploads = 0 in the [revu] stanza in dput.cf should be enforcing this anyway.

Inside your package directory, issue

   dpkg-buildpackage -S -sa -rfakeroot

-S builds a source package, and -sa includes the original source. If your GPG key is not configured correctly, add -kGPGKEYID to the command line.

Uploading it

Consider going through the REVU Checklist with your package.

dpkg-buildpackage will output a package-version_source.changes file, which is uploaded with dput.

   dput revu package_version_source.changes

If your firewall requires passive FTP, dput may hang while uploading. In that case, try dput -P package-version_source.changes.

IconsPage/note.png If you haven't set REVU as the default host (as explained previously), you need to specify to dput that you wish to use it on the command line: dput revu *_source.changes. The default host is the Ubuntu official repository, and if you are not an Ubuntu developer, your upload to the Ubuntu repository will be rejected.

If you are reuploading a changed package (after receiving reviews), you may get an error like this:

  Upload package to host revu
  Already uploaded to ubuntuwire.com
  Doing nothing for myapp_source.changes

To fix, add the -f option to dput to force the upload.

If you aborted an upload in progress, you might get an error like this:

  Error '553 Could not create file.' during ftp transfer of myapp.dsc
  Note: This problem might be caused by files already existent on the server.
  For the official Debian upload queues, the dcut(1) utility can be used
  to remove stale files from unsuccessful uploads.

To solve this, just wait 5 minutes. Processing of uploads is done every 5 min. If your upload doesn't show up, please contact the REVU administrators on the IRC channel #ubuntu-motu:

  • Siegfried Gevatter (RainCT)
  • Nathan Handler (nhandler)
  • Emmet Hikory (persia)
  • Jonathan Davies (jpds)
  • Morten Kjeldgaard (mok0)
  • Raphaël Pinson (raphink)
  • Richard Johnson (nixternal)

How to log in

REVU uses Launchpad's OpenID server. When you click "Login via Launchpad OpenID", you'll be redirected to Launchpad to confirm the login and then redirected back to REVU.

View and comment uploads

Packages uploaded to REVU are made public. You can browse them without logging in to the system.

However, only registered users can comment. Commenting on your own packages can be useful to give reviewers some info on the changes you have made between two uploads of your packages. You can also review packages from other people, even if you are not a MOTU, if you know for sure that what you write is true.

In order to know if a comment is from a MOTU, look at the icon before his name; if it shows a light bulb, it's from a contributor; if it shows the MOTU emblem, it's from a MOTU, and if it shows a green tick, that does not only mean that it's from a MOTU but also that he advocated the package.

Additional rules

  • You must have reviewed your package for known security vulnerabilities and provide patches for all of them.
  • We can refuse the package on the grounds of known security problems and design.
  • You must have included a copyright and license file, and those must allow inclusion of the package in the universe component and on mirrors.
  • The package must be known to build on top of the main component of the current Ubuntu stable release; it may require other packages already in universe.

Getting help

If you need help on these steps or if you have more questions about REVU, you can ask in #ubuntu-motu on the Freenode network.

What Next?

When your package has two MOTU advocates, it will be uploaded to Ubuntu's New queue. Here it will be reviewed yet again by an Archive Admin. Read more about this on the page REVUWhatNext.

Why contribute as Reviewer?

Do you have some experience in packaging and know policy well? Then you can help improving the packages uploaded to universe and guide packagers in doing so, by contributing as a reviewer on REVU.

Register as reviewer

What you need :

Please contact one of the REVU administrators (see a list on the statistics page) on the IRC channel #ubuntu-motu. We will mark you as Reviewer in the database.

Using REVU-Tools to review on REVU

See /REVU-Tools.

Reviewing Guidelines

When reviewing a package that needs work before upload, please summarise as many issues as possible in the REVU comment, so that the Uploader has a larger work list. It can be very frustrating to revise the package for each issue, and Uploaders may wonder if it will ever end.

If you advocate a package, please paste the URL in #ubuntu-motu with a notification of advocation, to encourage someone to upload it.

Tip: You can easily download a source package using the .dsc with dget (package devscripts)

dget -ux http://path/to/the/dsc/file

Feature Requests

Please submit feature requests and bug reports to the REVU Project on Launchpad.


CategoryMOTU

MOTU/Packages/REVU (last edited 2011-12-08 16:58:49 by allison)