Skip to content

Setup bumpr #40

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

Merged
merged 1 commit into from
Feb 8, 2020
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
8 changes: 8 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,14 @@ The new releases are pushed on `Pypi.org <https://pypi.org/>`_ automatically
from `GitHub Actions <https://github.com/python-restx/flask-restx/actions?query=workflow%3ARelease>`_ when we add a new tag (unless the
tests are failing).

In order to prepare a new release, you can use `bumpr <https://github.com/noirbizarre/bumpr>`_
which automates a few things.
You first need to install it, then run the ``bumpr`` command. You can then refer
to the `documentation <https://bumpr.readthedocs.io/en/latest/commandline.html>`_
for further details.
For instance, you would run ``bumpr -m`` (replace ``-m`` with ``-p`` or ``-M``
depending the expected version).

Updating Copyright
------------------

Expand Down
6 changes: 1 addition & 5 deletions bumpr.rc
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ clean =
inv clean
files =
README.rst
package.json

[bump]
unsuffix = true
Expand All @@ -17,11 +18,6 @@ unsuffix = true
part = patch
suffix = dev

[changelog]
file = CHANGELOG.rst
bump = {version} ({date:%Y-%m-%d})
prepare = Current

[readthedoc]
id = flask-restx

Expand Down
2 changes: 1 addition & 1 deletion flask_restx/__about__.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# -*- coding: utf-8 -*-
__version__ = '0.0.1.dev0'
__version__ = '0.1.0'
__description__ = 'Fully featured framework for fast, easy and documented API development with Flask'