Skip to content

Commit

Permalink
Update documentation on the release process and versioning
Browse files Browse the repository at this point in the history
  • Loading branch information
drmfinlay committed Oct 29, 2018
1 parent 6d55a46 commit 78263ec
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 13 deletions.
16 changes: 9 additions & 7 deletions documentation/release_process.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,24 +11,25 @@ Preparation

#. Determine the appropriate version number for this release,
according to :ref:`RefReleaseVersioning`.
#. Create the new release branch, named ``release-X.Y.Z``
#. Update the :file:`version.txt` file to contain the new version
number.

#. Tickets

#. Update ticket status for this release, where relevant:
https://github.com/t4ngo/dragonfly/issues
https://github.com/Danesprite/dragonfly/issues

#. Release files

#. Verify that :file:`CHANGES.txt` includes the change log for this
#. Verify that :file:`CHANGELOG.rst` includes the change log for this
release.
#. Verify that :file:`AUTHORS.txt` is up to date with recent
contributors.
#. Verify that :file:`setup.py` specifies all required
dependencies, including their versions, e.g. with the
``install_requires`` and ``test_requires`` parameters.
#. Verify that :file:`documentation/requirements.txt` specifies all
required dependencies for building the documentation.
#. Verify that :file:`MANIFEST.in` includes all necessary
data files.

Expand All @@ -46,15 +47,15 @@ Build and test

#. Test installation of distributions

#. Test on PyPI test server
#. Test on PyPI test server (`test.pypi.org <http://test.pypi.org/>`__)

#. Upload distributions to PyPI test server
#. Test installation from PyPI test server
#. Verify package is displayed correctly on PyPI test server

#. Tag release

#. Tag git revision
#. Tag git revision as ``X.Y.Z``
#. Push to GitHub

Release
Expand All @@ -63,13 +64,13 @@ Release
#. Upload to GitHub

#. Upload distributions to GitHub:
https://github.com/t4ngo/dragonfly/releases
https://github.com/Danesprite/dragonfly/releases

#. Trigger building of documentation on Read the Docs

#. Check whether documentation was built automatically, and if not
trigger it:
https://readthedocs.org/builds/dragonfly/
https://readthedocs.org/builds/dragonfly2/

#. Upload to PyPI server

Expand All @@ -84,3 +85,4 @@ Post-release

#. Website
#. Mailing list
#. Gitter channel
16 changes: 10 additions & 6 deletions documentation/release_versioning.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,18 @@ Release versioning

The versions of Dragonfly releases are strongly inspired by the
semantic versioning concept, as promoted by Tom Preston-Werner and
documented at `http://semver.org/`.
documented at `semver.org`_.

Each version string has the format "major.minor.patch", where each part
has the following meaning:

- *Major* --
- *Minor* --
- *Patch* --
- *Major* -- version when you make incompatible API changes.
- *Minor* -- version when you add functionality in a backwards-compatible
manner.
- *Patch* -- version when you make backwards-compatible bug fixes.

Please see `semver.org`_ for guidelines on version incrementation and other
topics.

.. _semver.org: https://semver.org

Version incrementation
============================================================================

0 comments on commit 78263ec

Please sign in to comment.