Skip to content

Commit

Permalink
docs(bump): Remove bump2version references #71 (#78)
Browse files Browse the repository at this point in the history
bump2version is no longer in use; automatic python-semantic-version
now updates versioning.

closes #71
  • Loading branch information
imAsparky committed Sep 15, 2021
1 parent 647c154 commit 78e61a0
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 28 deletions.
24 changes: 7 additions & 17 deletions README.rst
Expand Up @@ -28,6 +28,10 @@ keeping it automated and straightforward.**
.. :target: https://travis-ci.org/github/audreyfeldroy/cookiecutter-pypackage
.. :alt: Build Status
.. image:: https://www.repostatus.org/badges/latest/wip.svg
:alt: Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.
:target: https://www.repostatus.org/#wip

.. image:: https://app.codacy.com/project/badge/Grade/4c115acc2b3d4d13b998cdcbdb3cea64
:target: https://www.codacy.com/gh/imAsparky/cookiecutter-py3-package/dashboard?utm_source=github.com&utm_medium=referral&utm_content=imAsparky/cookiecutter-py3-package&utm_campaign=Badge_Grade
:alt: Code Quality
Expand Down Expand Up @@ -68,6 +72,9 @@ Cookiecutter_ template for a Python package.
closed or manually.
#. Semantic versioning and publishing are also available locally, bypassing
the need for a GitHub action if that is your preferred workflow.
#. Added optional GitHub custom issue templates. The four custom issue templates
prompt users to help provide enough information in a templated format for
each issue type.

Features
--------
Expand All @@ -83,22 +90,6 @@ Features
.. _CHANGELOG: https://github.com/imAsparky/cookiecutter-py3-package/blob/main/CHANGELOG.md
.. _Test-PyPi: https://test.pypi.org/


.. Build Status
.. -------------
.. Linux:
.. .. image:: https://img.shields.io/travis/audreyfeldroy/cookiecutter-pypackage.svg
.. :target: https://travis-ci.org/audreyfeldroy/cookiecutter-pypackage
.. :alt: Linux build status on Travis CI
.. Windows:
.. .. image:: https://ci.appveyor.com/api/projects/status/github/audreyr/cookiecutter-pypackage?branch=master&svg=true
.. :target: https://ci.appveyor.com/project/audreyr/cookiecutter-pypackage/branch/master
.. :alt: Windows build status on Appveyor
Quickstart
----------

Expand Down Expand Up @@ -170,7 +161,6 @@ make my own packaging experience better.
.. _Sphinx: http://sphinx-doc.org/
.. _Read the Docs: https://readthedocs.io/
.. _`pyup.io`: https://pyup.io/
.. _bump2version: https://github.com/c4urself/bump2version
.. _Punch: https://github.com/lgiordani/punch
.. _Poetry: https://python-poetry.org/
.. _PyPi: https://pypi.python.org/pypi
Expand Down
6 changes: 0 additions & 6 deletions docs/source/pypi_release_checklist.rst
Expand Up @@ -32,12 +32,6 @@ For Every Release
git add HISTORY.rst
git commit -m "Changelog for upcoming release 0.1.1."
#. Update version number (can also be patch or major)

.. code-block:: bash
bump2version minor
#. Install the package again for local development, but with the new version number:

.. code-block:: bash
Expand Down
2 changes: 2 additions & 0 deletions {{cookiecutter.project_slug}}/CHANGELOG.md
@@ -1 +1,3 @@
# CHANGELOG

<!--next-version-placeholder-->
9 changes: 4 additions & 5 deletions {{cookiecutter.project_slug}}/CONTRIBUTING.rst
Expand Up @@ -87,8 +87,8 @@ Ready to contribute? Here's how to set up `{{ cookiecutter.project_slug }}` for

6. Commit your changes and push your branch to GitHub::

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git add <please enter each new/modified/deleted file name here>
$ git commit <please fill in the commit message template as per the built in guide>
$ git push origin name-of-your-bugfix-or-feature

7. Submit a pull request through the GitHub website.
Expand Down Expand Up @@ -119,9 +119,8 @@ Deploying
---------

A reminder for the maintainers on how to deploy.
Make sure all your changes are committed (including an entry in HISTORY.rst).
Make sure all your changes are committed.
Then run::

$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags

0 comments on commit 78e61a0

Please sign in to comment.