pgTAP Release Management
Here are the steps to take to make a release of pgTAP:
Test on all supported PostgreSQL versions, starting with the latest version (10) and moving backward in order (9.6, 9.5, 9.4, etc.). pgenv is a handy tool for installing and switching between versions. For each version, ensure that:
Patches apply cleanly (try to eliminate Hunk warnings for patches to
pgtap.sqlitself, usually by fixing line numbers)
All files are installed (on 8.3 and earlier that includes pgtap.so).
ALTER EXTENSION pgtap UPDATE;works on 9.1 and higher.
CREATE EXTENSION pgtap;works on 9.1 and higher.
All tests pass in
make installcheck(on 8.1, move the pgtap source dir into the postgres source
contribdirectory and run
make NO_PGXS=1 installcheck)
If you've made any significant changes while testing versions backward, test them again in forward order (8.1, 8.2, 8.3, etc.) to make sure the changes didn't break any later versions.
Review the documentation in
doc/pgtap.mmd, and make any necessary changes, including to the list of PostgreSQL version-compatibility notes at the end of the document.
Add an item to the top of the
contrib/pgtap.spec. It should use the version you're about to release, as well as the date and your name and email address. Add at least one bullet mentioning the upgrade.
documentation.htmland delete all the lines between these "DOC" comments, until the main div looks like this:
<div id="main"> <!-- DOC INTRO HERE --> <!-- END DOC INTRO HERE --> <div id="toc"> <!-- TOC SANS "pgTAP x.xx" --> <!-- END TOC --> </div> <!-- DOCS HERE, WITH INTRO MOVED ABOVE --> <!-- END DOCS --> </div>
Copy the first
DOC INTRO HEREsection.
Copy the rest of
DOCS HERE, WITH INTRO MOVED ABOVEsection.
Copy the entire contents of
DOC SANS pgTAP x.xxsection, and then remove the first
<li>element that says "pgTAP x.xx".
Sanity-check that everything looks right; use
git diffto make sure nothing important was lost. It should mainly be additions.
Commit the changes, but don't push them yet.
Go back to the
masterbranch and proofread the additions to the
Changesfile since the last release. Make sure all relevant changes are recorded there, and that any typos or formatting errors are corrected.
Changesfile. I generate the timestamp like so:
perl -MDateTime -e 'print DateTime->now->datetime . "Z"'
Paste that into the line with the new version, maybe increment by a minute to account for the time you'll need to actually do the release.
Commit the timestamp and tag it:
git ci -m 'Timestamp v0.98.0.' git tag -am 'Tag v0.98.0.' v0.98.0
Package the source and submit to PGXN.
gem install pgxn_utils git archive --format zip --prefix=pgtap-0.98.0/ \ --output pgtap-0.98.0.zip master
Push all the changes to GitHub.
git push git push --tags
Increment the version to kick off development for the next release. The version should be added to the
Changesfile, and incremented in the following files:
META.json(including for the three parts of the
Commit that change and push it.
git ci -m 'Increment to v0.99.0.' git push
Start hacking on the next version!