aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobin Krahl <robin.krahl@ireas.org>2018-12-30 11:43:55 +0100
committerDaniel Mueller <deso@posteo.net>2019-01-07 18:34:58 -0800
commit097ee0ae905f1c0c09b21b30eafb421392aaef75 (patch)
tree2d423475a7cfb51e7345e11a4e58a6cd3fc9e8c2
parent5db376b22250d10e652d3e697f2b0a22e8446c76 (diff)
downloadnitrocli-097ee0ae905f1c0c09b21b30eafb421392aaef75.tar.gz
nitrocli-097ee0ae905f1c0c09b21b30eafb421392aaef75.tar.bz2
Add packaging documentation
To make life easier for possible future maintainers, this change documentes the packaging process for Arch Linux and Debian in the doc/packaging.md file. Note that nitrocli is not yet packaged for Debian, so that section is hypothetical.
-rw-r--r--nitrocli/doc/packaging.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/nitrocli/doc/packaging.md b/nitrocli/doc/packaging.md
new file mode 100644
index 0000000..24b1664
--- /dev/null
+++ b/nitrocli/doc/packaging.md
@@ -0,0 +1,52 @@
+How to package nitrocli
+=======================
+
+This document describes how to update the packaged versions of nitrocli.
+
+Arch Linux
+----------
+
+1. Clone the Git repository at ssh://aur@aur.archlinux.org/nitrocli.git.
+2. Edit the `PKGBUILD` file:
+ - Update the `pkgver` variable to the current nitrocli version.
+ - If the `pkgrel` variable is not 1, set it to 1.
+ - Update the SHA512 hash in the `sha512sums` variable for the new tarball.
+3. Update the `.SRCINFO` file by running `makepkg --printsrcinfo > .SRCINFO`.
+4. Verify that the package builds successfully by running `makepkg`.
+5. Verify that the package was built as expected by running `pacman -Qlp $f`
+ and `pacman -Qip $f`, where `$f` is `nitrocli-$pkgver.pkg.tar.gz`.
+6. Check the package for errors by running `namcap PKGBUILD` and `namcap
+ nitrocli-$pkgver.pkg.tar.gz`.
+7. Add, commit, and push your changes to publish them in the AUR.
+
+If you have to release a new package version without a new nitrocli version,
+do not change the `pkgver` variable and instead increment the `pkgrel`
+variable.
+
+For more information, see the [Arch User Repository][] page in the Arch Wiki.
+
+Debian
+------
+
+1. Clone or fork the Git repository at
+ https://salsa.debian.org/rust-team/debcargo-conf.
+2. Execute `./update.sh nitrocli`.
+3. Check and, if necessary, update the Debian changelog in the file
+ `src/nitrocli/debian/changelog`.
+4. Verify that the package builds successfully by running `./build.sh nitrocli`
+ in the `build` directory. (This requires an `sbuild` environment as
+ described in the `README.rst` file.)
+5. Inspect the generated package by running `dpkg-deb --info` and `dpkg-deb
+ --contents` on it.
+6. If you have push access to the repository, update the `TODO.rst` file to
+ indicate that `nitrocli` can be updated.
+7. Add and commit your changes. If you have push access, push them.
+ Otherwise create a merge request and indicate that `nitrocli` is ready for
+ upload in its description.
+
+For more information, see the [Teams/RustPackaging][] page in the Debian Wiki
+and the [README.rst file][] in the debcargo-conf repository.
+
+[Arch User Repository]: https://wiki.archlinux.org/index.php/Arch_User_Repository
+[Teams/RustPackaging]: https://wiki.debian.org/Teams/RustPackaging
+[README.rst file]: https://salsa.debian.org/rust-team/debcargo-conf/blob/master/README.rst