Releasing

To release a new version of vimdoc:

• Bump the version number in VERSION.txt. We'll refer to this version number as $VERSION below.
  • Check git log for changes since the last release. List them in the long commit message.
  • Push the commit to master. You don't need to bother with a pull request.
• Click "Draft a new release" on the Releases page.
• Find your commit under "Recent commits". Label the tag like "v$VERSION".
• Copy the list of changes from your earlier commit message.
• Build and upload a deb. See instructions below.
• Mark any corresponding Milestone on the Milestones page as closed.

Building the deb package

Vimdoc debs should be built for python3 targeting Ubuntu 14.04. These will work on newer versions of Ubuntu, but due to astraw/stdeb#83 we need to build targeting the earliest version of Ubuntu we want to support.

The best way to build proper debs is to use stdeb to build a dsc (Debian source package), and then use pbuilder from any host version of Ubuntu to build packages for Ubuntu Trusty (14.04):

• Add the following into a ~/.pydistutils.cfg file:

[global]
command-packages: stdeb.command

• Install the latest version of stdeb for python3 with pip3 install --user stdeb.
• Install dependencies for stdeb/debhelper if needed: Run sudo apt install debhelper python3-all dh-python.
• From a vimdoc repository directory, run python3 setup.py sdist_dsc.
• Set up pbuilder if you haven't already:
  • Run sudo apt-get install pbuilder ubuntu-dev-tools.
  • Run pbuilder-dist trusty create to create a chroot for building against Ubuntu Trusty. This will take several minutes to complete.
• Run pbuilder-dist trusty amd64 build deb_dist/vimdoc_$VERSION-1.dsc to build the deb.
• After it's built, upload the deb from ~/pbuilder/trusty_result/vimdoc_$VERSION-1_all.deb to the release page.