From 066fecafee99595473ae7f3838fa5ec376c64973 Mon Sep 17 00:00:00 2001 From: John Dewey Date: Mon, 7 Aug 2017 13:42:03 -0700 Subject: [PATCH] Added development documentation --- doc/source/changelog.rst | 2 ++ doc/source/contributing.rst | 2 ++ doc/source/development.rst | 68 +++++++++++++++++++++++++++++++++++++ doc/source/index.rst | 9 ++--- doc/source/testing.rst | 9 +++++ 5 files changed, 83 insertions(+), 7 deletions(-) create mode 100644 doc/source/development.rst create mode 100644 doc/source/testing.rst diff --git a/doc/source/changelog.rst b/doc/source/changelog.rst index 09929fe..08d4bd8 100644 --- a/doc/source/changelog.rst +++ b/doc/source/changelog.rst @@ -1 +1,3 @@ +.. _changelog: + .. include:: ../../CHANGELOG.rst diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index ac7b6bc..2b6578f 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributing.rst @@ -1 +1,3 @@ +.. _contributing: + .. include:: ../../CONTRIBUTING.rst diff --git a/doc/source/development.rst b/doc/source/development.rst new file mode 100644 index 0000000..2f58a13 --- /dev/null +++ b/doc/source/development.rst @@ -0,0 +1,68 @@ +*********** +Development +*********** + +* Please read the :ref:`contributing` guidelines. + +Branches +======== + +* The ``master`` branch is stable. Major changes should be performed + elsewhere. + +Release Engineering +=================== + +Pre-release +----------- + +* Edit the :ref:`changelog`. +* Follow the :ref:`testing` steps. + +Release +------- + +Gilt follows `Semantic Versioning`_. + +.. _`Semantic Versioning`: http://semver.org + +Tag the release and push to github.com +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. code-block:: bash + + $ git tag 2.0.0 + $ git push --tags + +Upload to `PyPI`_ +^^^^^^^^^^^^^^^^^ + +* Install `Twine`_ using `pip`. + + .. code-block:: bash + + $ pip install twine + +* Upload to `PyPI`_. + + .. code-block:: bash + + $ cd /path/to/gilt + $ rm -rf build/ dist/ + $ python setup.py sdist bdist_wheel + $ twine upload dist/* + $ rm -rf build/ dist/ + +Post-release +------------ + +* Comment/close any relevant `Issues`_. + +Roadmap +======= + +* See `Issues`_ on Github.com. + +.. _`PyPI`: https://pypi.python.org/pypi/python-gilt +.. _`ISSUES`: https://github.com/metacloud/gilt/issues +.. _`Twine`: https://pypi.python.org/pypi/twine diff --git a/doc/source/index.rst b/doc/source/index.rst index bee6b8e..666d06d 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -105,13 +105,6 @@ Integrates with `Molecule`_ as an `Ansible Galaxy`_ CLI replacement. Update name: shell command: gilt overlay -Testing -======= - -.. code-block:: bash - - $ pip install tox - $ tox Similar Tools ============= @@ -121,7 +114,9 @@ Similar Tools .. toctree:: :maxdepth: 3 + testing contributing + development changelog authors autodoc diff --git a/doc/source/testing.rst b/doc/source/testing.rst new file mode 100644 index 0000000..25127df --- /dev/null +++ b/doc/source/testing.rst @@ -0,0 +1,9 @@ +.. _testing: + +Testing +======= + +.. code-block:: bash + + $ pip install tox + $ tox