aniani/profanity
1
0
Fork 0
mirror of https://github.com/profanity-im/profanity.git synced 2024-12-04 14:46:46 -05:00
Code

autotools: fix make dist command

Browse Source 
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.
This commit is contained in:
Dmitry Podgorny 2019-03-04 18:26:28 +02:00
parent d0a1cae8e8
commit 0f0659aa09
2 changed files with 34 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
Makefile.am
View File

@ -185,7 +185,7 @@ themes_sources = $(top_srcdir)/themes/*
icons_sources = $(top_srcdir)/icons/* icons_sources = $(top_srcdir)/icons/*
script_sources = bootstrap.sh configure-debug script_sources = bootstrap.sh
man_sources = docs/profanity.1 man_sources = docs/profanity.1
@ -250,7 +250,20 @@ tests_unittests_unittests_LDADD = -lcmocka
man_MANS = $(man_sources) man_MANS = $(man_sources)
EXTRA_DIST = $(man_sources) $(icons_sources) $(themes_sources) $(script_sources) profrc.example LICENSE.txt README.md CHANGELOG EXTRA_DIST = $(man_sources) $(icons_sources) $(themes_sources) $(script_sources) profrc.example theme_template LICENSE.txt README.md CHANGELOG
# Ship API documentation with `make dist`
EXTRA_DIST += \
apidocs/c/c-prof.conf \
apidocs/c/gen.sh \
apidocs/c/profapi.h \
apidocs/c/profhooks.h \
apidocs/python/conf.py \
apidocs/python/gen.sh \
apidocs/python/index.rst \
apidocs/python/Makefile \
apidocs/python/src/plugin.py \
apidocs/python/src/prof.py
if INCLUDE_GIT_VERSION if INCLUDE_GIT_VERSION
EXTRA_DIST += .git/HEAD .git/index EXTRA_DIST += .git/HEAD .git/index

57
RELEASE_GUIDE.md
View File

@ -20,14 +20,13 @@ Usually release candidates are tagged 0.6.0.rc1, 0.6.0.rc2 and tested for a week
* Update profrc.example * Update profrc.example
## Creating artefacts ## Creating artefacts
* Clone the repository
* Set the correct release version in configure.ac: * Set the correct release version in configure.ac:
``` ```
AC_INIT([profanity], [0.6.0], [boothj5web@gmail.com]) AC_INIT([profanity], [0.6.0], [boothj5web@gmail.com])
``` ```
* Set the package status in configure ac: * Set the package status in configure.ac:
``` ```
PACKAGE_STATUS="release" PACKAGE_STATUS="release"
@ -36,13 +35,29 @@ PACKAGE_STATUS="release"
* Commit * Commit
* Tag (0.6.0) * Tag (0.6.0)
* Push * Push
* Set version to next release
* 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]) AC_INIT([profanity], [0.7.0], [boothj5web@gmail.com])
``` ```
* Set the pacakge status back to dev * Set the pacakge status back to dev:
``` ```
PACKAGE_STATUS="development" PACKAGE_STATUS="development"
@ -50,40 +65,6 @@ PACKAGE_STATUS="development"
* Create a branch for patch releases (0.6.patch) * Create a branch for patch releases (0.6.patch)
* Push * Push
* Clone the repository into a fresh folder and checkout the tag
```
git clone https://github.com/boothj5/profanity.git profanity-0.6.0
cd profanity-0.6.0
git checkout 0.6.0
```
* Remove files not needed in the artefcat
```
rm -rf apidocs .git
rm CHANGELOG configure-debug configure-plugins .gitignore profanity.spec prof.supp README.md theme_template travis-build.sh .travis.yml
```
* Bootstrap the build
```
./bootstrap.sh
```
* Remove automake cache
```
rm -rf autom4te.cache
```
* Leave the folder and create the artefacts
```
cd ..
tar -zcvf profanity-0.6.0.tar.gz profanity-0.6.0
zip -r profanity-0.6.0.zip profanity-0.6.0
```
## Updating website ## Updating website
* Make changes to the git repo incuding uploading the new artefacts at: * Make changes to the git repo incuding uploading the new artefacts at: