packaging/README.md

   1 Packaging Tools
   2 ===============
   3
   4 The programs in this folder are used when packaging from within git
   5 and are not included in source or binary packages.
   6
   7 For the most part they are used from the git commit hooks (copy
   8 `../hooks/*` to `../.git/hooks` to automate checking and the release
   9 process.
  10
  11 The check-files script pulls in `*.functions` and `*/*.functions` to
  12 do the actual work.
  13
  14 `packaging.functions` contains generic checks on e.g `ChangeLog`
  15 and `configure.ac` and automates release version, checking, tagging
  16 and post-release update.
  17
  18 Programs and packages with specific needs should create extra
  19 `whatever.functions` and supporting scripts in a subdirectory.
  20
  21 The `gpg.keys` file is a list of keys that can be expected to sign
  22 tags and packages.
  23
  24 Making a release
  25 ----------------
  26 `
  27 Just update ChangeLog and configure.ac to specify a suitable version
  28 suffix:
  29
  30     empty - final release
  31     pre.# - pre-release candidate
  32     rc.# - pre-release candidate
  33
  34 If it is a final release and there is a package.spec.in, add a new
  35 entry to the top of the %changelog section and update:
  36     PACKAGE_RPM_RELEASE="1"
  37
  38 The hooks will take over and if everything is OK will tag the release
  39 (you will be asked to sign the tag) and then update the files ready
  40 for further development.
  41
  42 The release is not pushed out automatically, so if you want to undo
  43 it, run:
  44
  45 ~~~~
  46 git reset --hard HEAD^^
  47 git tag -d vx.y.z
  48 ~~~~
  49
  50 Otherwise you can just push the results; the script outputs the required
  51 instructions upon success.
  52
  53 Once pushed the infrastructure will build a set of tar-files on the server.
  54 For information on how to verify, sign and make these available, see:
  55
  56     https://github.com/firehol/infrastructure/raw/master/doc/release.txt