1
0
Fork 0
profanity/RELEASE_GUIDE.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

84 lines
2.4 KiB
Markdown
Raw Normal View 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)
2019-01-16 11:29:24 +00:00
* 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 libprofanitys version needs to be [increased](https://github.com/profanity-im/profanity/issues/973)
2019-01-16 11:29:24 +00:00
* 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
2023-07-12 12:09:55 +00:00
* 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:
2023-08-03 06:26:23 +00:00
```
PACKAGE_STATUS="release"
```
* Update date and version in man pages
* 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.
2021-01-09 07:34:44 +00:00
* 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
```
2021-08-26 01:17:42 +00:00
* 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.
2021-01-09 07:34:44 +00:00
* Commit `Start new cycle`
* Push
## Updating website
2021-08-26 01:17:42 +00:00
* 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
2022-02-22 15:12:10 +00:00
* Take results from profanity.doap and put them into xeps.html