Uploading to Extras-devel

("non-free" packages)
("non-free" packages)
 
(One intermediate revision not shown)
Line 188: Line 188:
To upload file, run this command:
To upload file, run this command:
-
  pscp -v -scp '''<your_package_name_with_full_path>''' '''<username>'''@drop.maemo.org:/var/www/extras-devel/incoming-nonfree/fremantle/'''<your_package_name>'''.deb
+
  pscp -v -scp '''<deb_full_path>''' '''<username>'''@drop.maemo.org:/var/www/extras-devel/incoming-nonfree/fremantle/
Where you need to replace:
Where you need to replace:
-
- '''<your_package_name_with_full_path>''' - with absolute file path (example: ''C:\MyWork\my_app.deb'')
+
- '''<deb_full_path>''' - with absolute file path (example: ''C:\MyWork\my_app.deb'')
- '''<username>''' - your maemo garage username
- '''<username>''' - your maemo garage username
-
 
-
- '''<your_package_name>''' - how package should be named on server
 

Latest revision as of 21:20, 9 September 2012

Extras is the recommended home for all Maemo software. It provides an easy mechanism for users to discover new applications, and can help ensure quality and continued support for applications and their authors. Before an application can get to Extras, it must be uploaded to Extras-devel and promoted to Extras-testing. Community testing will begin, and finally the package can be promoted to Extras.

Contents

Pre-requisites

Three things are necessary to upload to maemo.org Extras:

  • A Garage account: [signup]
  • An "invitation" to upload: [request]
  • ssh-keygen (optional: not needed if only going to use the web-based upload)

Setup

Setting up SSH to upload to extras

This step is unnecessary if you are only going to use the web-based Extras Assistant wizard to upload.

Put your SSH key online:

  • If you need to create an RSA SSH key (make sure it is an RSA key):
    1. ssh-keygen -t rsa (enter, enter, passphrase (if desired), enter). This can be done from within MADDE as well.
  • Copy the contents of ~/.ssh/id_rsa.pub in the "Public SSH keys" section of your garage account maintenance page. This will be available once your upload-invitation request has been accepted

NOTE: If you modify public key in garage account, server will need some time to refresh that information (it should be done in few hours) otherwise you might get message "Server refused our key" (when you try to upload package).

Setting up Scratchbox to use the Extras repository

Add the extras repository to your Scratchbox install:

  1. Login to Scratchbox
  2. Create /etc/apt/sources.list.d/extras-repo.list
  3. Update apt's information.

Note: this should be done in both your ARMEL and x86 targets.

/scratchbox/login
cat >/etc/apt/sources.list.d/extras-repo.list <<EOT
#Maemo extras
deb http://repository.maemo.org/extras/ fremantle free non-free
deb-src http://repository.maemo.org/extras/ fremantle free
EOT
fakeroot apt-get update

Preparing a source package

Main article: Packaging


There are three main routes to creating source packages:

  1. Using Debian tooling directly.
  2. Using mud-builder to help repackage existing upstream sources.
  3. Using py2deb for Python applications.

Debian tooling

Main article: Documentation/Maemo_5_Developer_Guide/Packaging,_Deploying_and_Distributing#Creating_Debian_Packages


mud-builder

mud-builder uses a simple XML file to define an upstream source location (such as an svn location, web-based tarball or existing Debian package), it then handles the Maemo packaging specifics, builds a source package ready to upload and can even upload directly to Extras using a few simple commands:

mud build vim
mud upload vim

py2deb

Python applications can be developed inside or outside of Scratchbox. py2deb makes it easy to build packages ready for upload from a Python script.

PyPackager

PyPackager essentially replaces py2deb and provides the capabilities to build both a finished Debian Package (.deb) file as well as the source tarball and control files required by the garage build queues as py2deb does.

Upload

"free" packages

There are three mechanisms for uploading packages:

  1. The Extras Assistant is a web-based wizard, which guides you through the process
  2. Debian's dput tool
  3. SSH directly (using scp

dput

The /etc/dput.cf (or ~/.dput.cf) sections for free packages are:

[DEFAULT]
default_host_main = fremantle-extras-builder

[fremantle-extras-builder]
login = <your_garage_login_name>
fqdn = drop.maemo.org
method = scp
hash = md5
allow_unsigned_uploads = 1
incoming = /var/www/extras-devel/incoming-builder/fremantle

[diablo-extras-builder]
login = <your_garage_login_name>
fqdn = drop.maemo.org
method = scp
hash = md5
allow_unsigned_uploads = 1
incoming = /var/www/extras-devel/incoming-builder/diablo

[chinook-extras-builder]
login = <your_garage_login_name>
fqdn = drop.maemo.org
method = scp
hash = md5
allow_unsigned_uploads = 1
incoming = /var/www/extras-devel/incoming-builder/chinook

[gregale-extras-direct-binary-upload]
login = <your_garage_login_name>
fqdn = drop.maemo.org
method = scp
hash = md5
allow_unsigned_uploads = 1
incoming = /var/www/extras/incoming/gregale

Then run:

dput -f fremantle-extras-builder PACKAGE_VERSION_*.changes
dput -f diablo-extras-builder PACKAGE_VERSION_*.changes
dput -f chinook-extras-builder PACKAGE_VERSION_*.changes


For the single default case you should be able to do:

dput PACKAGE_VERSION_source.changes

and it should go to fremantle-extras-builder (because of the DEFAULT:default_host_main setting.

scp

Using scp directly is trivial:

scp *.tar.gz *.diff.gz *.changes *.dsc <your_garage_login_name>@drop.maemo.org:/var/www/extras-devel/incoming-builder/chinook/
scp *.tar.gz *.diff.gz *.changes *.dsc <your_garage_login_name>@drop.maemo.org:/var/www/extras-devel/incoming-builder/diablo/
scp *.tar.gz *.diff.gz *.changes *.dsc <your_garage_login_name>@drop.maemo.org:/var/www/extras-devel/incoming-builder/fremantle/


Note: Make sure you upload your .dsc files last. The .dsc file triggers a build and the autobuider might reject the package because of missing files.

"non-free" packages

Publishing non-free packages in the Maemo Extras Devel repository for Fremantle is done via dput. Direct upload of binary packages is allowed for non-free packages only.

Settings for dput.cf for Fremantle Extras-Devel non-free:

[fremantle-extras-devel-non-free]
login = <your_garage_login_name>
fqdn = drop.maemo.org
method = scp
hash = md5
allow_unsigned_uploads = 1
incoming = /var/www/extras-devel/incoming-nonfree/fremantle

Upload with dput:

dput -f fremantle-extras-devel-non-free PACKAGE_VERSION_*.changes

The packages are imported into the repository once per hour.

Please make sure your dependencies are correct. Should there be a dependency problem between a free and a non-free package, the non-free package will most likely be removed first. This is because we can recompile free packages, but cannot recompile non-free packages since we do not have the source.



For Windows 7

You will need these programs:

1) puttygen.exe

2) pageant.exe

3) pscp.exe


First run puttygen.exe, and make private and public keys (RSA). Save public and private key as files somewhere (and remember location!).

Open public key file with some text editor (notepad will do job), and now copy key.

This is how public key file should look like:

---- BEGIN SSH2 PUBLIC KEY ----
Comment: "rsa-key-20120905"
asdasdasda+dasdasdasdasasda3dasdasdasdasdasda/dasd=sdasd9asdasdas
asdasdasda+dasdasdasdasasda3dasdasdasdasdasda/dasd=sdasd9asdasdas
asdasdasda+dasdasdasdasasda3dasdasdasdasdasda/dasd=sdasd9asdasdas
asdasdas
---- END SSH2 PUBLIC KEY ----

You only need:

asdasdasda+dasdasdasdasasda3dasdasdasdasdasda/dasd=sdasd9asdasdasasdasdasda+dasdasdasdasasda3dasdasdasdasdasda/dasd=sdasd9asdasdasasdasdasda+dasdasdasdasasda3dasdasdasdasdasda/dasd=sdasd9asdasdasasdasdas

Just make sure that doesn't contain blank characters - eg. new line or space. Now you can put that in garage account with prefix "ssh-rsa", so at the end it should look like this:

ssh-rsa asdasdasda+dasdasdasdasasda3dasdasdasdasdasda/dasd=sdasd9asdasdasasdasdasda+dasdasdasdasasda3dasdasdasdasdasda/dasd=sdasd9asdasdasasdasdasda+dasdasdasdasasda3dasdasdasdasdasda/dasd=sdasd9asdasdasasdasdas


Now start pageant.exe and add that private key.

Open console (click on windows logo, and in search filed type "cmd" - without quotes - and press enter). Now go to folder where did you downloaded/putted pscp.exe file.


To upload file, run this command:

pscp -v -scp <deb_full_path> <username>@drop.maemo.org:/var/www/extras-devel/incoming-nonfree/fremantle/

Where you need to replace:

- <deb_full_path> - with absolute file path (example: C:\MyWork\my_app.deb)

- <username> - your maemo garage username


After that, wait for package to be uploaded and thats it :)

Autobuilder special considerations

If it builds under your local Scratchbox but doesn't on the autobuilder, you need to do the above dependency check (dpkg-depcheck) and/or otherwise correct the Build-Depends field: the builder uses the minimal rootstrap and only adds extra packages if they are mentioned in this field. This includes most -dev versions which include the special libraries and includes, and the pkg-config metadata; so applies to almost everything.

See Building packages with sbdmock for information on using the sbdmock tool to test your package build in a clean scratchbox environment before submitting to the autobuilder.

If you do not know what to write in the Build-Depends field, then in your scratchbox, install devscripts (apt-get install devscripts) and then run dpkg-genbuilddeps -rfakeroot in your source directory. The package will build in scratchbox and at the end, you will see a list of Build-Depends. Use common sense to figure out which Build-Depends you need to add. -dev packages are usually a good bet.

Also make sure the Section: in the control file is all lowercase, e.g. "user/navigation" not "user/Navigation", otherwise after building it will silently fail and NOT be moved to extras-devel.

The Autobuilder supports automatic Optification of packages, using the tool maemo-optify. You just need to create the file "debian/optify" containing the word "auto" to trigger maemo-optify during build. To predetermine the results of enabling maemo-optify, you can install this package from the Extras-devel repository inside your scratchbox and run maemo-optify-deb on a precompiled package.

If you have problems with the autobuilder, ask for help on the maemo-developers mailing list, and possibly contact the debmaster if you are sure that the problem is with the autobuilder and not your package.

In addition, one additional idea to increase package quality is to introduce Maemian, a lintian-like tool for Maemo . This would help in doing additional checks for common inconsistencies and errors.

Promotion

After the autobuilder builds a package, it will be available in Extras-Devel. This is the experimental repository.

Please make sure your package is ready for users by testing:

  • if it installs without problems
  • if it uninstalls without problems
  • if it doesn't introduce dependency problems for other packages.

You can promote your package to Extras with the promotion interface.

Promotion from Fremantle Extras-devel to Extras-testing and Extras-testing to Extras is done through the maemo.org package interface and the process is described in the Extras-testing documentation.

Additional information