diff --git a/Makefile.am b/Makefile.am index 45c87d76..c1784f32 100644 --- a/Makefile.am +++ b/Makefile.am @@ -185,7 +185,7 @@ themes_sources = $(top_srcdir)/themes/* icons_sources = $(top_srcdir)/icons/* -script_sources = bootstrap.sh configure-debug +script_sources = bootstrap.sh man_sources = docs/profanity.1 @@ -250,7 +250,20 @@ tests_unittests_unittests_LDADD = -lcmocka 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 EXTRA_DIST += .git/HEAD .git/index diff --git a/RELEASE_GUIDE.md b/RELEASE_GUIDE.md index 20686df9..90595583 100644 --- a/RELEASE_GUIDE.md +++ b/RELEASE_GUIDE.md @@ -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 ## Creating artefacts -* Clone the repository * Set the correct release version in configure.ac: ``` 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" @@ -36,13 +35,29 @@ PACKAGE_STATUS="release" * Commit * Tag (0.6.0) * 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]) ``` -* Set the pacakge status back to dev +* Set the pacakge status back to dev: ``` PACKAGE_STATUS="development" @@ -50,40 +65,6 @@ PACKAGE_STATUS="development" * Create a branch for patch releases (0.6.patch) * 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 * Make changes to the git repo incuding uploading the new artefacts at: