CHECKLIST.md

   1 # Checklist for code updates and new releases of Geeqie
   2
   3 ## Code Updates
   4
   5 ### Before compiling the sources, carry out the following actions when necessary
   6
   7 * Update `org.geeqie.Geeqie.appdata.xml.in` with the latest released version and date
   8
   9 * If source files have been added or removed from `./src/` directory, resync `./po/POTFILES.in`
  10
  11 ```sh
  12 cd ./po
  13 ./regen_potfiles.sh | patch -p0
  14 ```
  15
  16 * Keep translations in sync with the code
  17
  18 ```sh
  19 cd ./build
  20 meson compile geeqie-pot
  21 meson compile geeqie-update-po
  22 ```
  23
  24 * Update the desktop template if menus have changed
  25
  26 ```sh
  27 ./scripts/template-desktop.sh
  28 ```
  29
  30 ### After compiling the sources, carry out the following actions when necessary
  31
  32 * Update the man page and Command Line Options section in Help if the command line options have changed
  33
  34 ```sh
  35 ./scripts/generate-man-page.sh
  36 ```
  37
  38 * Update the keyboard shortcuts page in Help if any keyboard shortcuts have changed
  39
  40 ```sh
  41 ./doc/create-shortcuts-xml.sh
  42 ```
  43
  44 * Commit the changes and push to the .repo
  45
  46 * Update the web-page Help files if they have changed
  47     * commit and push if necessary
  48
  49 ```sh
  50 ./scripts/web-help.sh
  51 ```
  52
  53 * Copy `org.geeqie.Geeqie.desktop` to `<location of local geeqie.github.io>/`
  54 * Copy `org.geeqie.Geeqie.appdata.xml` to `<location of local geeqie.github.io>/`
  55 * Push changes to `geeqie.github.io`
  56
  57 ## New release
  58
  59 Carry out the above actions to ensure the master branch is up to date, and then the following actions for new version \<n.m\>.
  60
  61 * Edit `org.geeqie.Geeqie.appdata.xml.in` - Change date and version
  62 * Edit `NEWS` - The usual information. Ensure the first line is of the form `Geeqie <n.m[.p]>`
  63
  64 ```sh
  65 ./scripts/new-release.sh <-h for list of options>
  66 ```
  67
  68 * Go to `https://github.com/BestImageViewer/geeqie/releases` and click on `Draft a new release`.
  69
  70 * Under `Release title` insert "Geeqie \<n.m\>"
  71
  72 * Under `Choose a tag` select `v<n.m>`
  73
  74 * In `Describe this release` copy-paste the relevant section of `NEWS`.
  75
  76 * Upload the `/tmp/geeqie-<n.m>.tar.xz` and `/tmp/geeqie-<n.m>.tar.xz.asc` files created above
  77
  78 * Click `Publish release`
  79
  80 * Update the [Wikipedia entry](https://en.wikipedia.org/wiki/Geeqie)