|
1164.2.32
by David Coles
Very rough documentation for how we package IVLE. More information about the |
1 |
.. IVLE - Informatics Virtual Learning Environment
|
2 |
Copyright (C) 2007-2009 The University of Melbourne
|
|
3 |
||
4 |
.. This program is free software; you can redistribute it and/or modify
|
|
5 |
it under the terms of the GNU General Public License as published by
|
|
6 |
the Free Software Foundation; either version 2 of the License, or
|
|
7 |
(at your option) any later version.
|
|
8 |
||
9 |
.. This program is distributed in the hope that it will be useful,
|
|
10 |
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
11 |
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
12 |
GNU General Public License for more details.
|
|
13 |
||
14 |
.. You should have received a copy of the GNU General Public License
|
|
15 |
along with this program; if not, write to the Free Software
|
|
16 |
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
|
|
17 |
||
|
1466.1.1
by William Grant
Replace the Packaging document with a general Releases one, and cover both source tarball and Ubuntu package releases. |
18 |
********
|
19 |
Releases
|
|
20 |
********
|
|
21 |
||
22 |
To release IVLE, both generic source tarballs and Ubuntu packages should |
|
23 |
be published. |
|
24 |
||
25 |
Generating a source tarball
|
|
26 |
===========================
|
|
27 |
||
28 |
To generate a tarball of the current state of trunk, run ``bzr export
|
|
29 |
ivle-VERSION.tar.gz lp:ivle``.
|
|
30 |
||
31 |
||
32 |
Releasing it on Launchpad
|
|
33 |
=========================
|
|
34 |
||
35 |
As a member of the `IVLE Developers <https://launchpad.net/~ivle-dev>`_ team, |
|
36 |
visit the `IVLE project page <https://launchpad.net/ivle>`_. There you'll see |
|
37 |
a graph of IVLE's series, milestones and releases. |
|
38 |
||
39 |
Clicking on the series in which this release should be created will present |
|
40 |
a list of existing milestones and releases. If a milestone for this release |
|
41 |
already exists, click "Release now". If not, click "Create release". Enter |
|
42 |
the release date on the following form, and confirm the creation. |
|
43 |
||
44 |
To upload the release tarball for the world to see, hit "Add download file" on |
|
45 |
the release page. Give a meaningful description like "IVLE 1.0 source", select |
|
46 |
the file, and ensure that the type is "Code Release Tarball". |
|
47 |
||
48 |
||
49 |
.. seealso:: |
|
50 |
||
51 |
`Launchpad release documentation <https://help.launchpad.net/Projects/SeriesMilestonesReleases>`_ |
|
52 |
All you could ever want to know about Launchpad's series, milestones and |
|
53 |
releases model. |
|
54 |
||
55 |
||
56 |
Updating the Ubuntu package
|
|
57 |
===========================
|
|
58 |
||
59 |
An Ubuntu package is kept in the `PPA for production environments |
|
60 |
<https://launchpad.net/~unimelb-ivle/+archive/production>`_. Releases should
|
|
61 |
be pushed out to there if destined for production systems. The packaging is |
|
62 |
kept in a separate branch: `lp:~ivle-dev/ivle/debian-packaging |
|
63 |
<https://code.launchpad.net/~ivle-dev/ivle/debian-packaging>`_.
|
|
64 |
||
|
1466.1.2
by William Grant
Fix versioning instructions, and note prerequisites for uploading to the PPA. |
65 |
You will need to be a member of the `University of Melbourne IVLE developers |
66 |
<https://launchpad.net/~unimelb-ivle>`_ team, have an OpenPGP key assigned to
|
|
67 |
your account, and have signed the Ubuntu Code of Conduct. See the PPA |
|
68 |
documentation linked below for instructions. You should be able to build |
|
69 |
the package on any Debian-derived operating system that uses ``dpkg``.
|
|
|
1489
by William Grant
Note in the release docs that you need an SSH key set up. |
70 |
You also need to have an SSH key `associated with your account |
71 |
<https://help.launchpad.net/YourAccount/CreatingAnSSHKeyPair>`_ so you can
|
|
72 |
commit to the branch on Launchpad. |
|
|
1466.1.2
by William Grant
Fix versioning instructions, and note prerequisites for uploading to the PPA. |
73 |
|
|
1466.1.1
by William Grant
Replace the Packaging document with a general Releases one, and cover both source tarball and Ubuntu package releases. |
74 |
When performing a release, you should merge trunk into a checkout of the |
75 |
packaging branch. Then run ``dch -i`` to add a new Debian changelog entry.
|
|
76 |
For the Debian version string, append ``-0ppa1`` to the IVLE version (eg.
|
|
|
1484
by William Grant
Fix typos in the documentation |
77 |
``1.0-0ppa1``). Make sure that you target to the correct Ubuntu series
|
78 |
(currently ``hardy``). Also ensure that your name and email address are set
|
|
|
1466.1.2
by William Grant
Fix versioning instructions, and note prerequisites for uploading to the PPA. |
79 |
correctly at the bottom of the new entry. |
|
1466.1.1
by William Grant
Replace the Packaging document with a general Releases one, and cover both source tarball and Ubuntu package releases. |
80 |
|
81 |
Next ensure that you have a copy of the release tarball in the parent |
|
82 |
directory, named ``ivle_VERSION.orig.tar.gz``. Once that's there, run
|
|
|
1474
by David Coles
Docs: Clarification that debuild should be run in the package directory, not |
83 |
``debuild -S -sa -i`` to build the source package and have the results placed
|
84 |
in the parent directory. |
|
|
1466.1.1
by William Grant
Replace the Packaging document with a general Releases one, and cover both source tarball and Ubuntu package releases. |
85 |
|
86 |
``dput ppa:unimelb-ivle/production ivle_VERSION_source.changes`` will now
|
|
87 |
upload the package to the production PPA. You should receive an acknowledgement |
|
88 |
email from Launchpad within five minutes, at which point Launchpad will begin |
|
89 |
building binaries from the source package. You can check the build progress |
|
90 |
on the `PPA detail page |
|
|
1484
by William Grant
Fix typos in the documentation |
91 |
<https://launchpad.net/~unimelb-ivle/+archive/production/+packages>`_.
|
|
1466.1.1
by William Grant
Replace the Packaging document with a general Releases one, and cover both source tarball and Ubuntu package releases. |
92 |
|
93 |
Remember to commit to and push the ``debian-packaging`` branch when done.
|
|
94 |
||
95 |
.. seealso:: |
|
96 |
||
97 |
`Launchpad PPA documentation <https://help.launchpad.net/Packaging/PPA>`_ |
|
98 |
All you could ever want to know about using Launchpad's PPA |
|
99 |
functionality. |
|
100 |
||
101 |
`Ubuntu Packaging Guide <https://wiki.ubuntu.com/PackagingGuide/Basic>`_ |
|
102 |
All you could ever want to know about Ubuntu packaging. |