1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
|
Version Control System
======================
The Debian Hamradio Maintainers team has a project on `Alioth
<http://alioth.debian.org/>`_. You are encouraged to use this for managing git
repositories for the source of your team packages. If you do not currently have
an account on Alioth or have not requested to be added to the project, you will
need to do that before you can use this facility. To request to be added to the
project, send an email to the `mailing list
<https://lists.debian.org/debian-hams/>`_. In order to be able to push to the
repositories on Alioth, you will need to `add an SSH key
<https://alioth.debian.org/account/editsshkeys.php>`_ to your Alioth account.
Anonymous access to git repositories
------------------------------------
Anonymous access to git repositories is possible at the following URLs:
* https://salsa.debian.org/debian-hamradio-team/<pkg-name>.git (Preferred for the
Vcs-Git field)
Anonymous access to a web VCS browser is also available at the following URL:
* https://salsa.debian.org/debian-hamradio-team/<pkg-name>.git
You can also view an `index of all team git repositories
<https://salsa.debian.org/debian-hamradio-team>`_.
Repository layout
-----------------
The layout of the Git repository is important as we have QA tools that scan our
Git repositories for information. The recommended layout for repositories is
described by `DEP-14 <http://dep.debian.net/deps/dep14/>`_, which is
implemented by the ``git-buildpackage`` tool. Examples of this tool in use are
given below.
Importing an existing source package
------------------------------------
You will need ``git-buildpackage`` installed on your local machine before
following these steps.
If your package is not currently tracked with git, you can import the sources
from a source package.
Begin by logging into Alioth and creating the new repository:
::
cd /git/pkg-hamradio/
./setup-repository <pkg-name> "Packaging for <pkg-name> in Debian"
If you have the source package locally, you can skip this next step. If not,
you will need to download the source package from the Debian archives:
::
cd /tmp
apt-get source <pkg-name>
Then you need to create a local git repository on your machine and import the
source package:
::
mkdir <pkg-name>
cd <pkg-name>
git init
gbp import-dsc --pristine-tar /tmp/<pkg-name>*.dsc
Finally, in your local git repository, add the remote and push all branches and
tags:
::
git remote add origin git+ssh://alioth.debian.org/git/pkg-hamradio/<pkg-name>.git
git push origin --all
git push origin --tags
Please remember to update your ``Vcs-Git`` and ``Vcs-Browser`` fields in
``debian/control`` to match the URLs shown above for anonymous access.
Importing an existing git repository
------------------------------------
You will need ``git-buildpackage`` installed on your local machine before
following these steps.
If you've previously had a git repository elsewhere for your package, you can
import it quite easily.
Begin by logging into Alioth and creating the new repository:
::
cd /git/pkg-hamradio/
./setup-repository <pkg-name> "Packaging for <pkg-name> in Debian"
Then in your local git repository, add the remote and push all branches and
tags:
::
git remote remove origin
git remote add origin git+ssh://alioth.debian.org/git/pkg-hamradio/<pkg-name>.git
git push origin --all
git push origin --tags
This repository can now be cloned using git-buildpackage or you can continue to
work in your local repository pushing changes to the new origin.
Please remember to update your ``Vcs-Git`` and ``Vcs-Browser`` fields in
``debian/control`` to match the URLs shown above for anonymous access.
Even if your existing repository is on Alioth, do **NOT** just copy the
repository into ``/git/pkg-hamradio/``. The ``setup-repository`` script
adds commit hooks to the repository to aid in tracking commits.
Creating a new git repository for a new package
-----------------------------------------------
You will need ``git-buildpackage`` installed on your local machine before
following these steps.
Begin by logging into Alioth and creating the new repository:
::
cd /git/pkg-hamradio/
./setup-repository <pkg-name> "Packaging for <pkg-name> in Debian"
On your machine, download the upstream source tarball and keep it somewhere
safe. You will need a tarball to import, so if upstream distributes source as a
zip or other type of archive, you will need to repack it as a tarball.
Create a local git repository on your machine and import the tarball like so:
::
mkdir <pkg-name>
cd <pkg-name>
git init
gbp import-orig --pristine-tar /path/to/upstream/source.tar.gz
You'll now find that the upstream source has been imported into your git
repository.
You may optionally use the Debian Hamradio Maintainers template ``debian/``
directory:
::
svn export svn://anonscm.debian.org/svn/pkg-hamradio/trunk/package_template debian
When you are ready to push your changes to Alioth, add the remote and push all
branches and tags:
::
git remote add origin git+ssh://alioth.debian.org/git/pkg-hamradio/<pkg-name>.git
git push --all
git push --tags
Updating a package already in the team git
------------------------------------------
You can update an existing Debian package in git to the latest upstream with
one of the following commands:
::
gbp import-orig --pristine-tar --uscan # will use the watch file to locate
# the latest upstream
gbp import-orig --pristine-tar --download <URL> # will download a tarball
# from the URL before
# importing
gbp import-orig --pristine-tar /path/to/orig.tar.gz # import from local
# tarball
Testing package builds with git-buildpackage
--------------------------------------------
While building your package with git-pbuilder as described below will help you
to test building your package on a clean system and check your build
dependencies, it can take a long time to install the build dependencies every
time. You can build your package in the directory on your development system
while debugging build problems.
::
gbp buildpackage -us -uc
.. note:: The ``-us -uc`` options will be passed to ``dpkg-buildpackage`` and
disable the automatic signing of the package. There is no need to
sign the built packages when debugging.
The .dsc, .changes, .orig.tar.gz, .debian.tar.xz and .deb files will be placed
in the parent directory to your git repository.
Using git-buildpackage and git-pbuilder for building packages
-------------------------------------------------------------
``git-pbuilder`` builds your package in a chroot which ensures that your
package has the correct package dependencies and does not depend on any files
outside of the repository. It is included in the ``git-buildpackage`` package.
The first time you use git-pbuilder, you'll need to create a local unstable
chroot for the builds to be performed in. You will also need to make sure
cowbuilder is available on your system.
::
sudo apt-get install cowbuilder
sudo git-pbuilder create
In order to build your package from the git repository, run:
::
cd /path/to/repository
gbp buildpackage --git-pbuilder
Final build and upload
----------------------
If your package is ready for upload, you can update the changelog, perform a
final build with the updated changelog, sign your package using debsign and
then upload:
::
dch -r # this will set the distribution to unstable
gbp buildpackage --git-pbuilder --git-tag
cd ../
debsign <pkg>*.changes
dput <target> <pkg>*.changes
.. note:: You may choose to do the final build without ``git-pbuilder``, in
which case you can omit the ``--git-pbuilder`` argument from the
call to ``gbp buildpackage``. The .dsc and .changes files will also
be signed during the build so you do not have to use ``debsign`` if
you are not using ``git-pbuilder`` for the final build.
If you're not a Debian Maintainer or Debian Developer, you will not be able to
upload directly into the Debian archives. See the "Publishing your packages"
section of the `mentors.debian.org introduction
<http://mentors.debian.net/intro-maintainers>`_ to learn how to upload your
package there and then send a mail to the mailing list requesting sponsorship
for your package.
Backports and updates to stable distributions
---------------------------------------------
Backports and updates to stable distributions should be managed in a seperate
branch in the Git repositories. Backports should be managed in the branch with
the name of the stable distribution, e.g. the branch containing backports for
the current stable distribution should be named "jessie". Proposed updates for
the stable distributions should be managed in the branch with the name of the
stable distribution with "-pu" appended, e.g. the branch containing proposed
updates for the current stable distribution should be named "jessie-pu".
In order to use git-buildpackage to build the alternative branch, use the
--git-debian-branch argument:
::
gbp buildpackage --git-pbuilder --git-debian-branch=jessie
Tracking commit notifications
-----------------------------
Commit notifications are displayed in the `#debian-hams
<irc://irc.debian.org/#debian-hams>`_ IRC channel on irc.debian.org and can
also be found on the `pkg-hamradio-commits@lists.alioth.debian.org
<https://lists.alioth.debian.org/mailman/listinfo/pkg-hamradio-commits>`_
mailing list (`archives
<http://lists.alioth.debian.org/pipermail/pkg-hamradio-commits/>`_).
Futher Reading
--------------
For more information on using Git for packaging, see `the Git packages pages on
the wiki <http://wiki.debian.org/GitPackaging>`_.
|