RELEASE-HOWTO

This document provides a step-by-step list to remind Orca
maintainers how to make a release.

The general instructions for a release are here:

  https://wiki.gnome.org/MaintainersCorner/Releasing

See also:

  https://discourse.gnome.org/t/new-gnome-versioning-scheme/4235

Here's a summary for Orca:

PREPARE SOURCES FOR THE RELEASE:
-------------------------------

Make sure you are up to date:

  git pull
  git status

Update ./NEWS with changes from the last tagged release. You can use
commands like the following:

Detailed commits since the ORCA_40_BETA tag:

  git log ORCA_40_BETA..

Short list of translation changes with author names and files:

  git log ORCA_40_BETA.. --grep translation --pretty=format:"%s - %an" --name-only

Quick-and-dirty formatted list of translation changes:

  git log ORCA_40_BETA.. --grep translation --pretty=format:"%s,%an" --name-only |
    awk -F/ '/\.po/ {gsub("\\.po", "", $NF); printf(",%s",$NF); next;}
    {gsub("(Updated* |Add(ed)* | translation| help)", "", $0); printf("\n%s",$0);}' |
    awk -F, '!seen[$0]++ {if (NF == 3) printf("  %-15s %-25s %s\n", $3, $1, $2);}' |
    sort

Short list of non-translation commits:

  git log ORCA_40_BETA.. --grep translation --invert-grep --pretty=format:" * %s%n"

NOTE: You should also make sure the external dependencies listed in
meson.build and README.md are accurate.

COMMIT RELEASE CHANGES AND TAG THE RELEASE:
-------------------------------------------

git commit -a
git push
git tag -a -s ORCA_40_RC
git push origin ORCA_40_RC

BUILD THE RELEASE:
-----------------

meson setup builddir
meson dist -C builddir

UPLOAD THE RELEASE:
------------------

scp builddir/meson-dist/orca-40.rc.tar.xz yourusername@master.gnome.org:
ssh master.gnome.org
ftpadmin install orca-40.rc.tar.xz

BUMP THE VERSION:
-----------------

Modify this line in ./meson.build:

    version: '40.rc'

The major version (40) increments by 1 each new GNOME release cycle.
The minor version proceeds as follows: alpha, beta, rc, 0, 1, 2, 3, etc.

Modify ./README.md to make sure it has the right Orca version.

If this is a .0 release, modify this line in .gitlab/issue_templates/Default.md:

   *Note that versions prior to version XX.x are unsupported for non-critical issues.*

setting "XX" to the major release preceding this one.

git commit -a
git push