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

Prepare v0.11.0 #297

Merged
merged 3 commits into from
Aug 22, 2023
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
28 changes: 16 additions & 12 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,14 @@ Ready to contribute? Here's how to set up `clisops` for local development.
#.
Clone your fork locally:

..code-block:: shell
.. code-block:: shell

$ git clone git@github.com:roocs/clisops.git

#.
Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

..code-block:: shell
.. code-block:: shell

# For virtualenv environments:
$ mkvirtualenv clisops
Expand All @@ -84,7 +84,7 @@ Ready to contribute? Here's how to set up `clisops` for local development.
#.
Create a branch for local development:

..code-block:: shell
.. code-block:: shell

$ git checkout -b name-of-your-bugfix-or-feature

Expand All @@ -93,7 +93,7 @@ Ready to contribute? Here's how to set up `clisops` for local development.
#.
When you are done making changes, check that you verify your changes with `flake8` and `black` and run the tests, including testing other Python versions with `tox`:

..code-block:: shell
.. code-block:: shell

# For virtualenv environments:
$ pip install flake8 black pytest pytest-loguru tox
Expand All @@ -109,7 +109,7 @@ Ready to contribute? Here's how to set up `clisops` for local development.
#.
Before committing your changes, we ask that you install `pre-commit` in your virtualenv. `Pre-commit` runs git hooks that ensure that your code resembles that of the project and catches and corrects any small errors or inconsistencies when you `git commit`:

..code-block:: shell
.. code-block:: shell

# For virtualenv environments:
$ pip install pre-commit
Expand All @@ -123,7 +123,7 @@ Ready to contribute? Here's how to set up `clisops` for local development.
#.
Commit your changes and push your branch to GitHub:

..code-block:: shell
.. code-block:: shell

$ git add *

Expand Down Expand Up @@ -217,7 +217,9 @@ Before you submit a pull request, please follow these guidelines:
Tips
----

To run a subset of tests::
To run a subset of tests:

.. code-block:: shell

$ pytest tests.test_clisops

Expand Down Expand Up @@ -246,7 +248,7 @@ A reminder for the maintainers on how to deploy.
Make sure all your changes are committed (**including an entry in HISTORY.rst**).
Then run:

..code-block:: bash
.. code-block:: shell

$ bumpversion <option> # possible options: major / minor / patch / release
$ git push
Expand All @@ -260,11 +262,13 @@ The Manual Approach

From the command line in your distribution, simply run the following from the clone's main dev branch:

# To build the packages (sources and wheel)
$ flit build
.. code-block:: shell

# To build the packages (sources and wheel)
$ flit build

# To upload to PyPI
$ flit publish
# To upload to PyPI
$ flit publish

The new version based off of the version checked out will now be available via pip ($ pip install clisops).

Expand Down
2 changes: 1 addition & 1 deletion HISTORY.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Version History
===============

v0.11.0 (unreleased)
v0.11.0 (2023-08-22)
--------------------

New Features
Expand Down
2 changes: 1 addition & 1 deletion clisops/__version__.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
__copyright__ = "Copyright 2018 United Kingdom Research and Innovation"
__email__ = "eleanor.smith@stfc.ac.uk"
__license__ = "BSD"
__version__ = "0.10.1"
__version__ = "0.11.0"
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@
# the built documents.
#
# The short X.Y version.
version = "0.10.1"
version = "0.11.0"
# The full version, including alpha/beta/rc tags.
release = version

Expand Down
6 changes: 3 additions & 3 deletions setup.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpversion]
current_version = 0.10.1
current_version = 0.11.0
commit = True
tag = True

Expand All @@ -12,15 +12,15 @@ search = version = "{current_version}"
replace = version = "{new_version}"

[flake8]
exclude =
exclude =
.git,
docs,
build,
.eggs,
tests/mini-esgf-data
max-line-length = 88
max-complexity = 12
ignore =
ignore =
C901
E203
E231
Expand Down