Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added development documentation #56

Merged
merged 1 commit into from
Aug 7, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions doc/source/changelog.rst
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
.. _changelog:

.. include:: ../../CHANGELOG.rst
2 changes: 2 additions & 0 deletions doc/source/contributing.rst
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
.. _contributing:

.. include:: ../../CONTRIBUTING.rst
68 changes: 68 additions & 0 deletions doc/source/development.rst
Original file line number Diff line number Diff line change
@@ -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
9 changes: 2 additions & 7 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
=============
Expand All @@ -121,7 +114,9 @@ Similar Tools
.. toctree::
:maxdepth: 3

testing
contributing
development
changelog
authors
autodoc
Expand Down
9 changes: 9 additions & 0 deletions doc/source/testing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
.. _testing:

Testing
=======

.. code-block:: bash

$ pip install tox
$ tox