devs/cproof
1
2
Fork 1
Code Issues 43 Pull Requests 6 Actions Packages Projects 1 Releases Wiki Activity
Files
24e1dac354da131c2d04a5388779114e08843bfe
cproof/RELEASE_GUIDE.md
Jabber Developer b4d3563b96
All checks were successful
CI / Check coding style (push) Successful in 29s
Details
CI / Check spelling (push) Successful in 16s
Details
CI / Linux (debian) (push) Successful in 9m35s
Details
CI / Linux (arch) (push) Successful in 11m27s
Details
CI / Linux (fedora) (push) Successful in 13m57s
Details
CI / Linux (ubuntu) (push) Successful in 11m21s
Details
Cleanup (#5) 
- Update formatting for stub files
- Update docs

While original project, Profanity, provides valuable basis for this
fork, we are not affiliated with the upstream. This commit
is updating documentation to reflect accurate information.

The docs are going to be updated further once the website is created.

Reviewed-on: devs/profanity#5
Co-authored-by: Jabber Developer <jabber.developer@jabber.space>
Co-committed-by: Jabber Developer <jabber.developer@jabber.space>
2025-06-20 18:20:47 +00:00

2.4 KiB
Raw Blame History

Release Guide

  • Release libstrophe 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 copyright dates in all files

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

  • Determine if libprofanity's version needs to be increased

  • 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

  • Update profanity.doap (new XEPs and latest version). Look for DEV which marks what is done on the development branch.

  • Add new release to profanity.doap

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"

  • Update date and version in man pages (profanity.1, profanity-ox-setup.1)

  • Generate manpages for profanity commands (the mangen argument only works when package status is development) ./profanity mangen These files should be added to the docs subfolder and added to git whenever a command changes.

  • Add generated command manpages: git add docs/profanity-*.1

  • Commit

  • Tag (0.1.2)

  • Push

  • Configure to generate fresh Makefile:

./bootstrap.sh && ./configure
  • Generate tarballs:
make dist
make dist-bzip2
make dist-xz
make dist-zip
  • Set the package status back to dev:
PACKAGE_STATUS="development"

  • Remove generated command manpages: git rm docs/profanity-*.1 git checkout HEAD -- docs/profanity-ox-setup.1 docs/profanity.1 and docs/profanity-ox-setup.1 are handwritten.

  • Commit Start new cycle

  • Push

Updating website

  • Make changes to the git repo including uploading the new artefacts at: https://github.com/profanity-im/profanity-im.github.io
  • Add .xz and .zip tarballs to tarballs directory
  • Copy guide/latest to guide/newversion
  • Update tarball location and name in index.html
  • Update checksums in index.html
  • Update profanity_version.txt
  • Take results from profanity.doap and put them into xeps.html