Skip to content

Commit

Permalink
docs: Add note about automatic releases in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
relekang committed Feb 9, 2020
1 parent 07b3208 commit e606e75
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions readme.rst
Expand Up @@ -75,11 +75,20 @@ Configuration

Configuration belongs in ``semantic_release`` section of the setup.cfg
file in your project. Details about configuration options can be found
in `the configuration
documentation <http://python-semantic-release.readthedocs.org/en/latest/configuration.html>`__.
in `the configuration documentation <http://python-semantic-release.readthedocs.org/en/latest/configuration.html>`__.


Running it on CI
~~~~~~~~~~~~~~~~

Getting a fully automated setup with automatic releases from CI can be helpful for some projects.
It was the main motivation to create this tool. There is a dedicated documentation page for setting
up with different CI tools:
`Automatic release with CI documentation <https://python-semantic-release.readthedocs.io/en/latest/automatic-releases/index.html>`__


.. |Build status| image:: https://circleci.com/gh/relekang/python-semantic-release/tree/master.svg?style=svg
:target: https://circleci.com/gh/relekang/python-semantic-release/tree/master
.. |PyPI version| image:: https://badge.fury.io/py/python-semantic-release.svg


0 comments on commit e606e75

Please sign in to comment.