aniani/profanity
1
0
Fork 0
mirror of https://github.com/profanity-im/profanity.git synced 2024-06-09 21:30:42 +00:00
Code
dc0b4b5ecf
profanity/RELEASE_GUIDE.md

82 lines
2.0 KiB
Markdown
Raw Normal View History

Reformat RELEASE_GUIDE as md and add more info
2019-01-15 12:57:05 +00:00
# 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 RELEASE_GUIDE.md
2019-01-16 11:29:24 +00:00
* Update Inline command help (./src/command/cmd_defs.c)
Fix spelling
2021-08-26 01:17:42 +00:00
* Check copyright dates in all files (Copywright 2012-2019)
Reformat RELEASE_GUIDE as md and add more info
2019-01-15 12:57:05 +00:00
* Generate HTML docs (the docgen argument only works when package status is development)
`./profanity docgen`
Create cmd to generate man pages for prof commands `profanity mangen` will create for each command (`/account`, `/roster`) an own manpage (`profanity-account.1`, `profanity-roster.1`) See https://github.com/profanity-im/profanity/issues/1444 Needs some polishing formatting wise.
2020-12-04 16:29:31 +00:00
* 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.
Update release guide with libprofanity info
2019-06-11 05:45:11 +00:00
* Determine if libprofanitys version needs to be [increased](https://github.com/profanity-im/profanity/issues/973)
Update RELEASE_GUIDE.md
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
Reformat RELEASE_GUIDE as md and add more info
2019-01-15 12:57:05 +00:00
* Update CHANGELOG
* Update profrc.example
## Creating artefacts
* Set the correct release version in configure.ac:
```
AC_INIT([profanity], [0.6.0], [boothj5web@gmail.com])
```
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 16:26:28 +00:00
* Set the package status in configure.ac:
Reformat RELEASE_GUIDE as md and add more info
2019-01-15 12:57:05 +00:00
```
PACKAGE_STATUS="release"
```
Mention manpages in release guide
2021-01-09 07:34:44 +00:00
* Add generated command manpages: `git add docs/profanity-*.1`
Reformat RELEASE_GUIDE as md and add more info
2019-01-15 12:57:05 +00:00
* Commit
* Tag (0.6.0)
* Push
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 16:26:28 +00:00
* Configure to generate fresh Makefile:
Reformat RELEASE_GUIDE as md and add more info
2019-01-15 12:57:05 +00:00
```
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 16:26:28 +00:00
./bootstrap.sh && ./configure
Reformat RELEASE_GUIDE as md and add more info
2019-01-15 12:57:05 +00:00
```
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 16:26:28 +00:00
* Generate tarballs:
Reformat RELEASE_GUIDE as md and add more info
2019-01-15 12:57:05 +00:00
```
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 16:26:28 +00:00
make dist
make dist-bzip2
make dist-xz
make dist-zip
Reformat RELEASE_GUIDE as md and add more info
2019-01-15 12:57:05 +00:00
```
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 16:26:28 +00:00
* Set version to next release:
Reformat RELEASE_GUIDE as md and add more info
2019-01-15 12:57:05 +00:00
```
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 16:26:28 +00:00
AC_INIT([profanity], [0.7.0], [boothj5web@gmail.com])
Reformat RELEASE_GUIDE as md and add more info
2019-01-15 12:57:05 +00:00
```
Fix spelling
2021-08-26 01:17:42 +00:00
* Set the package status back to dev:
Reformat RELEASE_GUIDE as md and add more info
2019-01-15 12:57:05 +00:00
```
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 16:26:28 +00:00
PACKAGE_STATUS="development"
Reformat RELEASE_GUIDE as md and add more info
2019-01-15 12:57:05 +00:00
```
Mention manpages in release guide
2021-01-09 07:34:44 +00:00
* Remove generated command manpages: `git rm docs/profanity-*.1`
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 16:26:28 +00:00
* Create a branch for patch releases (0.6.patch)
* Push
Reformat RELEASE_GUIDE as md and add more info
2019-01-15 12:57:05 +00:00
## Updating website
Fix spelling
2021-08-26 01:17:42 +00:00
* Make changes to the git repo including uploading the new artefacts at:
Update profanity repo URL Move from github.com/boothj5/* to github.com/profanity-im/*
2019-05-03 08:51:28 +00:00
https://github.com/profanity-im/profanity-im.github.io
Mention profnaity_version in release guide
2020-07-09 15:03:05 +00:00
* Update profanity_version.txt
Copy Permalink