1
0
mirror of https://github.com/profanity-im/profanity.git synced 2024-10-06 20:03:46 -04:00
profanity/RELEASE_GUIDE.md
Dmitry Podgorny 0f0659aa09 autotools: fix make dist command
Now, `make dist` can be used for generating tarballs. It simplifies
making proper release tarballs. Also, it includes some files, that
are removed in RELEASE_GUIDE.md:
 - apidocs/
 - CHANGELOG
 - theme_template
It is a good idea to include such a kind of documentation.

Update RELEASE_GUIDE.md.
2019-03-04 18:26:28 +02:00

1.6 KiB

Release Guide

Usually release candidates are tagged 0.6.0.rc1, 0.6.0.rc2 and tested for a week or so.

  • Release libstrophe and libmesode if required

  • Run Unit tests: make check-unit

  • Run Functional tests - Currently disabled

  • Run manual valgrind tests for new features

  • Build and simple tests in Virtual machines ideally all dists including OSX and Windows (Cygwin)

  • Update Inline command help (./src/command/cmd_defs.c)

  • Check copright dates in all files (Copywright 2012-2019)

  • Generate HTML docs (the docgen argument only works when package status is development) ./profanity docgen

  • Update plugin API docs (./apidocs/c and ./apidocs/python) need to run the gen.sh and commit the results to the website git repo

  • Update CHANGELOG

  • Update profrc.example

Creating artefacts

  • Set the correct release version in configure.ac:
AC_INIT([profanity], [0.6.0], [boothj5web@gmail.com])
  • Set the package status in configure.ac:
PACKAGE_STATUS="release"
  • Commit

  • Tag (0.6.0)

  • Push

  • Configure to generate fresh Makefile:

./bootstrap.sh && ./configure
  • Generate tarballs:
make dist
make dist-bzip2
make dist-xz
make dist-zip
  • Set version to next release:
AC_INIT([profanity], [0.7.0], [boothj5web@gmail.com])
  • Set the pacakge status back to dev:
PACKAGE_STATUS="development"
  • Create a branch for patch releases (0.6.patch)
  • Push

Updating website