RELEASING.md

Releasing

Source code

Edit variable $VERSION in check_pgbackrest, and update the version field at the end of the in-line documentation in this script.

Use date format LC_TIME=C date +"%a %b %d %Y".

Update the CHANGELOG.md file too.

Documentation

Generate updated documentation:

pod2text check_pgbackrest > README
podselect check_pgbackrest > README.pod

Tagging and building tar file

TAG=REL2_5
git tag -a $TAG -m "Release $TAG"
git tag
git push --tags
git archive --prefix=check_pgbackrest-$TAG/ -o /tmp/check_pgbackrest-2.5.tar.gz $TAG

Release on github

• Go to https://github.com/pgstef/check_pgbackrest/releases

• Edit the release notes for the new tag

• Set "check_pgbackrest $VERSION" as title, eg. "check_pgbackrest 2.5"

• Here is the format of the release node itself: YYYY-MM-DD - Version X.Y

  Changelog:

  • item 1
  • item 2
  • ...

• Upload the tar file

• Save

• Check or update https://github.com/pgstef/check_pgbackrest/releases

Community

Submit a news on postgresql.org

• Title: "check_pgbackrest 2.5 has been released"
• Content:

_Town, Country, Month xx, 2024_

`check_pgbackrest` is designed to monitor [pgBackRest](https://pgbackrest.org) 
backups from Nagios, relying on the status information given by the 
[info](https://pgbackrest.org/command.html#command-info) command.

It allows to monitor the backups retention and the consistency of the archived 
WAL segments.

Changes in check_pgbackrest 2.5
--------------------------------------------------------------------------------

  * ...
  * ...

Links & Credits
--------------------------------------------------------------------------------
This is an open project, licensed under the PostgreSQL license. 
Any contribution to improve it is welcome.

Links:

  * Download: https://github.com/pgstef/check_pgbackrest/releases
  * Support: https://github.com/pgstef/check_pgbackrest/issues

• check "Related Open Source"