diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 86de0ed52..5bf9af962 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -13,13 +13,13 @@ repos: - id: debug-statements - id: requirements-txt-fixer - repo: https://github.com/asottile/pyupgrade - rev: 'v2.10.0' + rev: 'v2.11.0' hooks: - id: pyupgrade args: - --py36-plus - repo: https://github.com/pycqa/isort - rev: '5.7.0' + rev: '5.8.0' hooks: - id: isort - repo: https://github.com/psf/black diff --git a/ChangeLog.md b/ChangeLog.md index 5ace78de1..d13bcb05f 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -4,6 +4,11 @@ The format is based on and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). +## v2.5.1 - 2021-04-06 + +### Fixed +* Documentation on ReadTheDocs builds and renders. + ## v2.5.0 - 2021-03-16 ### Changed diff --git a/contributors.txt b/contributors.txt index 7e8d00c84..5b3aaaae2 100644 --- a/contributors.txt +++ b/contributors.txt @@ -1,8 +1,8 @@ 2066 Vyas Ramasubramani - 1862 Bradley Dice + 1889 Bradley Dice 1030 Eric Harper 456 Jin Soo Ihm - 281 Joshua A. Anderson + 288 Joshua A. Anderson 240 Matthew Spellings 159 Kelly Wang 110 Erin Teich @@ -11,10 +11,10 @@ 43 Brandon Butler 41 Yezhi Jin 40 Antonio Osorio + 39 dependabot 35 Michael Stryk - 35 dependabot 31 Richmond Newman - 30 Tommy Waltmann + 31 Tommy Waltmann 25 Carl Simon Adorf 22 Jens Glaser 14 Tim Moore diff --git a/doc/source/conf.py b/doc/source/conf.py index d63fdabfa..40642d75f 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -70,8 +70,8 @@ # built documents. # # version and release are set the same for this package. -version = "2.5.0" -release = "2.5.0" +version = "2.5.1" +release = "2.5.1" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. diff --git a/doc/source/reference/development/releases.rst b/doc/source/reference/development/releases.rst index 5107aa922..f2591e003 100644 --- a/doc/source/reference/development/releases.rst +++ b/doc/source/reference/development/releases.rst @@ -73,11 +73,13 @@ Contributors git shortlog -sne > contributors.txt +- Check the ``git diff`` for that file. If any contributors are listed twice, update the ``.mailmap`` file so that all contributors are recognized under a canonical name and email. Then re-run the previous command. + Bump version ------------ - Commit previous changes before running ``bumpversion``. -- Use the `bumpversion package `_ to increase the version number and automatically generate a git tag: +- Use the `bumpversion package `_ to increase the version number: .. code-block:: bash @@ -97,10 +99,12 @@ Bump version Pushing the release branch will cause CircleCI to create a release for TestPyPI automatically (see automation in ``.circleci/config.yml``). Make sure this succeeds -- it takes a while to run. Review the `TestPyPI builds `__ to ensure the README looks correct. - Then push the tag: + +- Create and push a tag for the release. .. code-block:: bash + git tag -a vX.Y.Z git push --tags Automatic Builds diff --git a/freud/__init__.py b/freud/__init__.py index 1d6cfe1c3..f078c6842 100644 --- a/freud/__init__.py +++ b/freud/__init__.py @@ -23,7 +23,7 @@ # automatic selection runs, the user cannot change it. set_num_threads(0) -__version__ = "2.5.0" +__version__ = "2.5.1" __all__ = [ "__version__", diff --git a/setup.cfg b/setup.cfg index 5bf784097..3cb102087 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 2.5.0 +current_version = 2.5.1 commit = True tag = True message = Bump up to version {new_version}. diff --git a/setup.py b/setup.py index 961291fa6..8bbbd29be 100644 --- a/setup.py +++ b/setup.py @@ -6,7 +6,7 @@ from skbuild import setup as skbuild_setup -version = "2.5.0" +version = "2.5.1" # Read README for PyPI, fallback to short description if it fails. description = "Powerful, efficient trajectory analysis in scientific Python."