Releases: cjolowicz/cookiecutter-hypermodern-python
2022.6.3
Overview of Changes
Here are the major changes brought by this release:
- Convert the entire documentation to Markdown, using MyST to support rich Markdown in Sphinx.
- Switch to isort as the Python import sorter, replacing reorder-python-imports. Enforce a single import per line to minimize merge conflicts.
- Remove upper version bounds from all dependencies.
- Restrict Dependabot updates to the lock file, greatly reducing the number of merge conflicts between Dependabot PRs.
- Enable Dependabot updates for indirect dependencies.
- Run Typeguard under the latest Python release only, to allow for the use of modern typing syntax.
- Combine coverage data under the latest Python release. This avoids problems due to changes in the AST between Python versions.
- Support patching Git hooks installed by recent versions of pre-commit, which use bash instead of Python for the hook script.
- Add a template variable for the copyright year.
- Do not run darglint on every commit to mitigate performance issues.
Read on for the full list of changes.
Changes
This section lists changes that affect generated projects.
🪲 Fixes
- Support patching pre-commit hooks written in bash (#718, #721, #1121) @cjolowicz @jooh
🚨 Testing
- Replace reorder-python-imports with isort (#741) @cjolowicz
- Combine coverage under the latest Python release (#710) @cjolowicz
- Run Typeguard under the latest Python release only (#764) @staticdev
- Move darglint to its own manual pre-commit hook (#822) @paw-lu
- Do not repeat Python versions in
@session
decorators (#711) @cjolowicz
👷 Continuous Integration
- Use
FORCE_COLOR
instead ofnox --force-color
(#778) @cjolowicz - Enable Dependabot updates for indirect dependencies (#747) @cjolowicz
- Restrict Dependabot updates to lock file to reduce merge conflicts (#746) @cjolowicz
📚 Documentation
- Convert documentation to Markdown using MyST (#1089) @cauliyang
- Add copyright year as a template variable (#1101) @jasonwashburn
- Update Code of Conduct to Contributor Covenant 2.1 (#1139) @eyllanesc
- Add link for contact email in the Code of Conduct (#1135) @eyllanesc
- Link to project license instead of license templates (#1138, #1149) @eyllanesc
- Remove unused reference to Cookiecutter project (#1136) @paw-lu
- Use
author
template variable in copyright notice (#1110) @sgraaf - Fix broken link to Contributor Guide on PyPI (#726) @staticdev
- Update permanently moved links in documentation (#738) @staticdev
📦 Packaging
- Remove upper version bounds from dependencies (#744, #709) @cjolowicz
- Add myst-parser to development dependencies (#815) @cjolowicz
⬆️ Dependencies
Dependabot PRs
- Bump actions/cache from 2.1.7 to 3 (cjolowicz/cookiecutter-hypermodern-python-instance#867) @dependabot
- Bump actions/checkout from 2.4.0 to 3 (cjolowicz/cookiecutter-hypermodern-python-instance#846) @dependabot
- Bump actions/download-artifact from 2.0.10 to 2.1.0 (cjolowicz/cookiecutter-hypermodern-python-instance#725) @dependabot
- Bump actions/download-artifact from 2.1.0 to 3 (cjolowicz/cookiecutter-hypermodern-python-instance#847) @dependabot
- Bump actions/setup-python from 2.3.0 to 2.3.1 (cjolowicz/cookiecutter-hypermodern-python-instance#712) @dependabot
- Bump actions/setup-python from 2.3.1 to 2.3.2 (cjolowicz/cookiecutter-hypermodern-python-instance#807) @dependabot
- Bump actions/setup-python from 2.3.2 to 3 (cjolowicz/cookiecutter-hypermodern-python-instance#844) @dependabot
- Bump actions/upload-artifact from 2.2.4 to 2.3.0 (cjolowicz/cookiecutter-hypermodern-python-instance#724) @dependabot
- Bump actions/upload-artifact from 2.3.0 to 2.3.1 (cjolowicz/cookiecutter-hypermodern-python-instance#732) @dependabot
- Bump actions/upload-artifact from 2.3.1 to 3 (cjolowicz/cookiecutter-hypermodern-python-instance#848) @dependabot
- Bump attrs from 21.2.0 to 21.3.0 (cjolowicz/cookiecutter-hypermodern-python-instance#751) @dependabot
- Bump attrs from 21.3.0 to 21.4.0 (cjolowicz/cookiecutter-hypermodern-python-instance#757) @dependabot
- Bump babel from 2.9.1 to 2.10.1 (cjolowicz/cookiecutter-hypermodern-python-instance#899) @dependabot
- Bump bandit from 1.7.1 to 1.7.2 (cjolowicz/cookiecutter-hypermodern-python-instance#793) @dependabot
- Bump beautifulsoup4 from 4.10.0 to 4.11.1 (cjolowicz/cookiecutter-hypermodern-python-instance#897) @dependabot
- Bump black from 21.11b1 to 21.12b0 (cjolowicz/cookiecutter-hypermodern-python-instance#723) @dependabot
- Bump black from 21.12b0 to 22.1.0 (cjolowicz/cookiecutter-hypermodern-python-instance#798) @dependabot
- Bump black from 22.1.0 to 22.3.0 (cjolowicz/cookiecutter-hypermodern-python-instance#915) @dependabot
- Bump certifi from 2021.10.8 to 2022.5.18.1 (cjolowicz/cookiecutter-hypermodern-python-instance#922) @dependabot
- Bump charset-normalizer from 2.0.10 to 2.0.11 (cjolowicz/cookiecutter-hypermodern-python-instance#799) @dependabot
- Bump charset-normalizer from 2.0.11 to 2.0.12 (cjolowicz/cookiecutter-hypermodern-python-instance#825) @dependabot
- Bump charset-normalizer from 2.0.8 to 2.0.9 (cjolowicz/cookiecutter-hypermodern-python-instance#722) @dependabot
- Bump charset-normalizer from 2.0.9 to 2.0.10 (cjolowicz/cookiecutter-hypermodern-python-instance#772) @dependabot
- Bump click from 8.0.3 to 8.0.4 (cjolowicz/cookiecutter-hypermodern-python-instance#837) @dependabot
- Bump click from 8.0.4 to 8.1.3 (cjolowicz/cookiecutter-hypermodern-python-instance#905) @dependabot
- Bump codecov/codecov-action from 2.1.0 to 3.1.0 (cjolowicz/cookiecutter-hypermodern-python-instance#889) @dependabot
- Bump coverage from 6.1.2 to 6.2 (cjolowicz/cookiecutter-hypermodern-python-instance#715) @dependabot
- Bump coverage from 6.2 to 6.3 (cjolowicz/cookiecutter-hypermodern-python-instance#792) @dependabot
- Bump coverage from 6.3 to 6.3.1 (cjolowicz/cookiecutter-hypermodern-python-instance#803) @dependabot
- Bump coverage from 6.3.1 to 6.3.2 (cjolowicz/cookiecutter-hypermodern-python-instance#833) @dependabot
- Bump coverage from 6.3.2 to 6.3.3 (cjolowicz/cookiecutter-hypermodern-python-instance#910) @dependabot
- Bump coverage from 6.3.3 to 6.4 (cjolowicz/cookiecutter-hypermodern-python-instance#924) @dependabot
- Bump coverage from 6.4 to 6.4.1 (cjolowicz/cookiecutter-hypermodern-python-instance#933) @dependabot
- Bump crazy-max/ghaction-github-labeler from 3.1.1 to 4.0.0 (cjolowicz/cookiecutter-hypermodern-python-instance#926) @dependabot
- Bump distlib from 0.3.3 to 0.3.4 (cjolowicz/cookiecutter-hypermodern-python-instance#727) @dependabot
- Bump filelock from 3.4.0 to 3.4.1 (cjolowicz/cookiecutter-hypermodern-python-instance#745) @dependabot
- Bump filelock from 3.4.1 to 3.4.2 (cjolowicz/cookiecutter-hypermodern-python-instance#748) @dependabot
- Bump filelock from 3.4.2 to 3.5.1 (cjolowicz/cookiecutter-hypermodern-python-instance#829) @dependabot
- Bump filelock from 3.5.1 to 3.6.0 (cjolowicz/cookiecutter-hypermodern-python-instance#830) @dependabot
- Bump filelock from 3.6.0 to 3.7.0 (cjolowicz/cookiecutter-hypermodern-python-instance#895) @dependabot
- Bump filelock from 3.7.0 to 3.7.1 (cjolowicz/cookiecutter-hypermodern-python-instance#931) @dependabot
- Bump flake8-bandit from 2.1.2 to 3.0.0 (cjolowicz/cookiecutter-hypermodern-python-instance#856) @dependabot
- Bump flake8-bugbear from 21.11.29 to 22.1.11 (cjolowicz/cookiecutter-hypermodern-python-instance#782) @dependabot
- Bump flake8-bugbear from 21.9.2 to 21.11.29 (cjolowicz/cookiecutter-hypermodern-python-instance#717) @dependabot
- Bump flake8-bugbear from 22.1.11 to 22.3.20 (cjolowicz/cookiecutter-hypermodern-python-instance#868) @dependabot
- Bump flake8-bugbear from 22.3.20 to 22.4.25 (cjolowicz/cookiecutter-hypermodern-python-instance#890) @dependabot
- Bump flake8-rst-docstrings from 0.2.3 to 0.2.4 (cjolowicz/cookiecutter-hypermodern-python-instance#728) @dependabot
- Bump flake8-rst-docstrings from 0.2.4 to 0.2.5 (cjolowicz/cookiecutter-hypermodern-python-instance#729) @dependabot
- Bump furo from 2021.11.23 to 2022.1.2 (cjolowicz/cookiecutter-hypermodern-python-instance#769) @dependabot
- Bump furo from 2021.11.23 to 2022.1.2 in /docs (cjolowicz/cookiecutter-hypermodern-python-instance#766) @dependabot
- Bump furo fr...
2021.11.26
Overview of Changes
Here are the major changes brought by this release:
-
Add a pre-commit hook for pyupgrade, a tool for upgrading your source code to newer versions of the Python language and standard library.
-
Use the furo Sphinx theme for documentation. Furo is a clean customizable theme for technical documentation, with a focus on being responsive and easy to navigate and search.
-
Include the test suite itself when measuring code coverage: tests are code. Read more about the reasons behind this on Ned Batchelder's blog.
-
Enable color output on GitHub Actions for pytest, pre-commit, Sphinx, and xdoctest. Tools on GitHub Actions default to monochrome output, and every tool has its own convention for overriding this (if any). This was a fun ride.
Read on for the full list of changes.
Changes
This section lists changes that affect generated projects.
🚨 Testing
- Include test suite in code coverage (#545) @cjolowicz
👷 Continuous Integration
- Add pre-commit hook for pyupgrade (#674) @cjolowicz
- Enable colors from pre-commit, pytest, Sphinx, and xdoctest (#700) @cjolowicz
- Use Python 3.10 on Read the Docs (#698) @cjolowicz
- Pin pip in virtual environments (#707) @cjolowicz
- Update test GA workflow for more consistent style (#697) @staticdev
- Shorten
python-version
topython
in Tests workflow matrix (#699) @cjolowicz
📚 Documentation
- Use furo Sphinx theme for documentation (#676) @cjolowicz
📦 Dependencies
- Avoid semver constraints for dependencies using CalVer (#675) @cjolowicz
Dependabot PRs
- Bump actions/cache from 2.1.6 to 2.1.7 (#702) @dependabot
- Bump actions/setup-python from 2.2.2 to 2.3.0 (#691) @dependabot
- Bump bandit from 1.7.0 to 1.7.1 (#677) @dependabot
- Bump black from 21.10b0 to 21.11b0 (#690) @dependabot
- Bump black from 21.11b0 to 21.11b1 (#696) @dependabot
- Bump charset-normalizer from 2.0.7 to 2.0.8 (#706) @dependabot
- Bump coverage from 6.1.1 to 6.1.2 (#673) @dependabot
- Bump filelock from 3.3.2 to 3.4.0 (#689) @dependabot
- Bump furo from 2021.11.12 to 2021.11.16 (#688) @dependabot
- Bump furo from 2021.11.12 to 2021.11.16 in /docs (#684) @dependabot
- Bump furo from 2021.11.16 to 2021.11.23 (#705) @dependabot
- Bump furo from 2021.11.16 to 2021.11.23 in /docs (#703) @dependabot
- Bump identify from 2.3.5 to 2.3.6 (#686) @dependabot
- Bump identify from 2.3.6 to 2.3.7 (#694) @dependabot
- Bump identify from 2.3.7 to 2.4.0 (#701) @dependabot
- Bump jinja2 from 3.0.2 to 3.0.3 (#668) @dependabot
- Bump nox-poetry from 0.8.6 to 0.9.0 in /.github/workflows (#692) @dependabot
- Bump packaging from 21.0 to 21.3 (#693) @dependabot
- Bump pbr from 5.7.0 to 5.8.0 (#695) @dependabot
- Bump pyparsing from 2.4.7 to 3.0.6 (#678) @dependabot
- Bump pyupgrade from 2.29.0 to 2.29.1 (#685) @dependabot
- Bump regex from 2021.11.2 to 2021.11.10 (#669) @dependabot
- Bump snowballstemmer from 2.1.0 to 2.2.0 (#687) @dependabot
- Bump sphinx from 4.2.0 to 4.3.0 (#672) @dependabot
- Bump sphinx from 4.2.0 to 4.3.0 in /docs (#671) @dependabot
- Bump typeguard from 2.13.0 to 2.13.2 (#704) @dependabot
- Bump typing-extensions from 3.10.0.2 to 4.0.0 (#682) @dependabot
Changes to the template infrastructure
This section lists changes to the infrastructure of the Cookiecutter template. These changes don't affect generated projects.
👷 Continuous Integration
- Ignore our RTD page when checking links in documentation (#1081) @cjolowicz
📚 Documentation
- Use furo Sphinx theme for Cookiecutter documentation (#612) @cjolowicz
- Document pre-commit hook for pyupgrade (#1065) @cjolowicz
- Add furo Sphinx theme to the Cookiecutter documentation (#1066) @cjolowicz
- Add furo Sphinx theme to the Cookiecutter documentation (#1067) @cjolowicz
- Document code coverage for the test suite (#1075) @cjolowicz
- Add section explaining how to upgrade Nox and Poetry (#1076) @cjolowicz
📦 Dependencies
Dependabot PRs
- Bump actions/cache from 2.1.6 to 2.1.7 (#1078) @dependabot
- Bump actions/setup-python from 2.2.2 to 2.3.0 (#1071) @dependabot
- Bump cutty from 0.16.0 to 0.17.0 in /.github/workflows (#1064) @dependabot
- Bump furo from 2021.11.12 to 2021.11.12.1 in /docs (#1068) @dependabot
- Bump furo from 2021.11.12.1 to 2021.11.16 in /docs (#1070) @dependabot
- Bump furo from 2021.11.16 to 2021.11.23 in /docs (#1079) @dependabot
- Bump nox-poetry from 0.8.6 to 0.9.0 in /.github/workflows (#1072) @dependabot
- Bump sphinx from 4.2.0 to 4.3.0 in /docs (#1063) @dependabot
2021.11.10
Overview of Changes
This release upgrades the CI checks on Windows and macOS to Python 3.10.
Changes
👷 Continuous Integration
- Use Python 3.10 on Windows and macOS in Tests workflow (cjolowicz/cookiecutter-hypermodern-python-instance#664) @cjolowicz
📦 Dependencies
- Update dependencies (cjolowicz/cookiecutter-hypermodern-python-instance#663) @cjolowicz
Changes to the template infrastructure
👷 Continuous Integration
- Use cutty to update the Cookiecutter instance (#1059, #1060, #1061) @cjolowicz
2021.11.8
Overview of Changes
- This release adds support for Python 3.10, while dropping support for Python 3.6
(EOL in December 2021). - Poetry and Nox are now installed on GitHub Actions using pipx, in isolated environments.
- mypy is now configured to warn about unreachable code.
Read on for the full list of changes.
Changes
This section lists changes affecting generated projects.
💥 Breaking Changes
- Drop support for Python 3.6 (#1054) @cjolowicz
🚀 Features
- Support Python 3.10 (#1052) @cjolowicz
👷 Continuous Integration
- Install Poetry and Nox using pipx in Tests workflow (#1051) @cjolowicz
🚨 Testing
- [nox] Chain exception correctly (#1015) @oncleben31
- [mypy] Warn about unreachable code (#1025) @cjolowicz
📚 Documentation
- Fix typo in CONTRIBUTING.rst (#1010) @benjaminrose
📦 Dependencies
- Bump actions/checkout from 2.3.4 to 2.4.0 (#1026) @cjolowicz
- Bump babel from 2.9.0 to 2.9.1 (#1023) @cjolowicz
- Bump black from 20.8b1 to 21.10b0 (#1055) @cjolowicz
- Bump click from 8.0.1 to 8.0.3 (#1042) @cjolowicz
- Bump codecov/codecov-action from 1.5.2 to 2.0.2 (#994) @cjolowicz
- Bump codecov/codecov-action from 2.0.2 to 2.1.0 (#1034) @cjolowicz
- Bump coverage from 5.5 to 6.1.1 (#1041) @cjolowicz
- Bump darglint from 1.8.0 to 1.8.1 (#1048) @cjolowicz
- Bump flake8 from 3.9.2 to 4.0.1 (#1044) @cjolowicz
- Bump flake8-bugbear from 21.4.3 to 21.9.2 (#1043) @cjolowicz
- Bump nox from 2021.6.12 to 2021.10.1 in /.github/workflows (#1031) @cjolowicz
- Bump pep8-naming from 0.12.0 to 0.12.1 (#1037) @cjolowicz
- Bump pip from 21.1.3 to 21.2.1 in /.github/workflows (#993) @cjolowicz
- Bump pip from 21.2.1 to 21.3.1 in /.github/workflows (#1028) @cjolowicz
- Bump poetry from 1.1.7 to 1.1.11 in /.github/workflows (#1030) @cjolowicz
- Bump pre-commit from 2.13.0 to 2.15.0 (#1035) @cjolowicz
- Bump prettier from 2.3.0 to 2.4.1 (#1056) @cjolowicz
- Bump pygments from 2.9.0 to 2.10.0 (#1036) @cjolowicz
- Bump pytest from 6.2.4 to 6.2.5 (#1038) @cjolowicz
- Bump reorder-python-imports from 2.5.0 to 2.6.0 (#986) @cjolowicz
- Bump sphinx from 4.1.1 to 4.1.2 (#992) @cjolowicz
- Bump sphinx from 4.1.1 to 4.1.2 in /docs (#988) @cjolowicz
- Bump sphinx from 4.1.2 to 4.2.0 (#1040) @cjolowicz
- Bump sphinx from 4.1.2 to 4.2.0 in /docs (#1032) @cjolowicz
- Bump sphinx-click from 3.0.1 to 3.0.2 (#1046) @cjolowicz
- Bump sphinx-click from 3.0.1 to 3.0.2 in /docs (#1047) @cjolowicz
- Bump sphinx-rtd-theme from 0.5.2 to 1.0.0 (#1049) @cjolowicz
- Bump sphinx-rtd-theme from 0.5.2 to 1.0.0 in /docs (#1033) @cjolowicz
- Bump typeguard from 2.12.1 to 2.13.0 (#1039) @cjolowicz
- Bump urllib3 from 1.26.4 to 1.26.5 (#1024) @cjolowicz
- Bump virtualenv from 20.6.0 to 20.10.0 in /.github/workflows (#1027) @cjolowicz
- Bump xdoctest from 0.15.5 to 0.15.10 (#1029) @cjolowicz
Changes to the Cookiecutter
This section lists changes to the Cookiecutter that don't affect generated projects.
📚 Documentation
- Drop statement about release cadence from User Guide (#1057) @cjolowicz
👷 Continuous Integration
📦 Dependencies
- Bump actions/checkout from 2.3.4 to 2.3.5 (#1017) @dependabot
- Bump actions/checkout from 2.3.5 to 2.4.0 (#1022) @dependabot
- Bump nox from 2021.6.12 to 2021.10.1 in /.github/workflows (#1013) @dependabot
- Bump pip from 21.1.3 to 21.2.1 in /.github/workflows (#984) @dependabot
- Bump pip from 21.2.1 to 21.2.3 in /.github/workflows (#998) @dependabot
- Bump pip from 21.2.3 to 21.2.4 in /.github/workflows (#1001) @dependabot
- Bump pip from 21.2.4 to 21.3 in /.github/workflows (#1016) @dependabot
- Bump pip from 21.3 to 21.3.1 in /.github/workflows (#1019) @dependabot
- Bump poetry from 1.1.10 to 1.1.11 in /.github/workflows (#1014) @dependabot
- Bump poetry from 1.1.7 to 1.1.8 in /.github/workflows (#1002) @dependabot
- Bump poetry from 1.1.8 to 1.1.10 in /.github/workflows (#1009) @dependabot
- Bump pre-commit from 2.13.0 to 2.14.0 in /.github/workflows (#997) @dependabot
- Bump pre-commit from 2.14.0 to 2.15.0 in /.github/workflows (#1005) @dependabot
- Bump sphinx from 4.1.1 to 4.1.2 in /docs (#991) @dependabot
- Bump sphinx from 4.1.2 to 4.2.0 in /docs (#1006) @dependabot
- Bump virtualenv from 20.6.0 to 20.7.2 in /.github/workflows (#1000) @dependabot
- Bump virtualenv from 20.7.2 to 20.8.0 in /.github/workflows (#1007) @dependabot
- Bump virtualenv from 20.8.0 to 20.8.1 in /.github/workflows (#1012) @dependabot
- Bump virtualenv from 20.8.1 to 20.9.0 in /.github/workflows (#1018) @dependabot
- Bump virtualenv from 20.9.0 to 20.10.0 in /.github/workflows (#1020) @dependabot
2021.7.15
Overview of Changes
This release allows marking the development status (e.g. alpha, beta, stable) when generating a project. The development status is included in the package metadata and indicated by a badge in the README and documentation.
Changes
This section lists changes affecting generated projects.
🚀 Features
- Add Trove classifier for Development Status (#981) @cjolowicz
📦 Dependencies
- Bump actions/download-artifact from 2.0.9 to 2.0.10 (#973) @cjolowicz
- Bump actions/upload-artifact from 2.2.3 to 2.2.4 (#974) @cjolowicz
- Bump mypy from 0.902 to 0.910 (#972) @cjolowicz
- Bump pep8-naming from 0.11.1 to 0.12.0 (#968) @cjolowicz
- Bump pip from 21.1.2 to 21.1.3 in /.github/workflows (#970) @cjolowicz
- Bump poetry from 1.1.6 to 1.1.7 in /.github/workflows (#971) @cjolowicz
- Bump sphinx from 4.0.2 to 4.1.1 (#975) @cjolowicz
- Bump sphinx from 4.0.2 to 4.1.1 in /docs (#976) @cjolowicz
- Bump virtualenv from 20.4.7 to 20.5.0 in /.github/workflows (#965) @cjolowicz
- Bump virtualenv from 20.5.0 to 20.6.0 in /.github/workflows (#977) @cjolowicz
- Bump xdoctest from 0.15.4 to 0.15.5 (#969) @cjolowicz
Changes to the Cookiecutter
This section lists changes to the Cookiecutter that don't affect generated projects.
📚 Documentation
- Update Poetry installation instructions to use
install-poetry.py
(#960) @staticdev
📦 Dependencies
- Bump pip from 21.1.2 to 21.1.3 in /.github/workflows (#954) @dependabot
- Bump poetry from 1.1.6 to 1.1.7 in /.github/workflows (#955) @dependabot
- Bump sphinx from 4.0.2 to 4.0.3 in /docs (#958) @dependabot
- Bump sphinx from 4.0.3 to 4.1.0 in /docs (#961) @dependabot
- Bump sphinx from 4.1.0 to 4.1.1 in /docs (#979) @dependabot
- Bump virtualenv from 20.4.7 to 20.5.0 in /.github/workflows (#964) @dependabot
- Bump virtualenv from 20.5.0 to 20.6.0 in /.github/workflows (#980) @dependabot
2021.6.16
Changes
🚨 Testing
- Remove types-click from Nox session for mypy (#952) @cjolowicz
📚 Documentation
- Remove reference to mypy.ini from User Guide (#950) @cjolowicz
📦 Dependencies
- Update poetry.lock (#951) @cjolowicz
2021.6.15
Overview of Changes
- Generated projects now have one configuration file less, as the mypy configuration was moved to the
pyproject.toml
file. - Documentation is now built using Python 3.9, both on ReadTheDocs and locally.
- The
noxfile.py
now requires a recent version of Nox.
Read on for the complete list of changes.
Changes
This section lists changes affecting generated projects.
🚨 Testing
- Move
mypy
configuration intopyproject.toml
(#935) @yeskunall - Update pre-commit hook for Prettier to new repository (#916) @staticdev
- Simplify Nox session for code coverage (#943) @cjolowicz
- Add per-machine coverage data files to
.gitignore
file (#886) @cjolowicz
📚 Documentation
- Use Python 3.9 when building on ReadTheDocs (#946) @cjolowicz
- Bump docs and docs-build session python to 3.9 (#646) @staticdev
📦 Dependencies
Expand
- Require click 8.x (#947) @staticdev
- Bump actions/cache from 2.1.5 to 2.1.6 (#923) @cjolowicz
- Bump actions/checkout from 2.3.3 to 2.3.4 (#931) @cjolowicz
- Bump click from 7.1.2 to 8.0.1 (#944) @cjolowicz
- Bump click from 7.1.2 to 8.0.1 in poetry.lock (#945) @cjolowicz
- Bump codecov/codecov-action from 1.5.0 to 1.5.2 (#920) @cjolowicz
- Bump codecov/codecov-action from v1.3.2 to v1.4.1 (#892) @cjolowicz
- Bump codecov/codecov-action from v1.4.1 to v1.5.0 (#900) @cjolowicz
- Bump flake8 from 3.9.0 to 3.9.1 (#881) @cjolowicz
- Bump flake8 from 3.9.1 to 3.9.2 (#932) @cjolowicz
- Bump flake8-rst-docstrings from 0.0.14 to 0.1.1 (#880) @cjolowicz
- Bump flake8-rst-docstrings from 0.0.14 to 0.2.1 (#889) @cjolowicz
- Bump flake8-rst-docstrings from 0.2.1 to 0.2.2 (#896) @cjolowicz
- Bump flake8-rst-docstrings from 0.2.2 to 0.2.3 (#898) @cjolowicz
- Bump mypy from 0.812 to 0.902 (#937) @cjolowicz
- Bump nox from 2020.12.31 to 2021.6.12 in /.github/workflows (#936) @cjolowicz
- Bump nox-poetry from 0.8.5 to 0.8.6 in /.github/workflows (#940) @cjolowicz
- Bump pip from 21.0.1 to 21.1 in /.github/workflows (#890) @cjolowicz
- Bump pip from 21.1 to 21.1.1 in /.github/workflows (#897) @cjolowicz
- Bump pip from 21.1.1 to 21.1.2 in /.github/workflows (#926) @cjolowicz
- Bump pre-commit from 2.12.0 to 2.12.1 (#893) @cjolowicz
- Bump pre-commit from 2.12.1 to 2.13.0 (#925) @cjolowicz
- Bump pre-commit-hooks from 3.4.0 to 4.0.1 (#928) @cjolowicz
- Bump pygments from 2.8.1 to 2.9.0 (#899) @cjolowicz
- Bump pytest from 6.2.3 to 6.2.4 (#902) @cjolowicz
- Bump reorder-python-imports from 2.4.0 to 2.5.0 (#888) @cjolowicz
- Bump sphinx from 3.5.4 to 4.0.2 (#941) @cjolowicz
- Bump sphinx from 3.5.4 to 4.0.2 in /docs (#927) @cjolowicz
- Bump sphinx-click from 2.7.1 to 3.0.1 (#938) @cjolowicz
- Bump sphinx-click from 2.7.1 to 3.0.1 in /docs (#939) @cjolowicz
- Bump typeguard from 2.12.0 to 2.12.1 (#921) @cjolowicz
- Bump virtualenv from 20.4.3 to 20.4.4 in /.github/workflows (#891) @cjolowicz
- Bump virtualenv from 20.4.4 to 20.4.6 in /.github/workflows (#904) @cjolowicz
- Bump virtualenv from 20.4.4 to 20.4.7 in /.github/workflows (#924) @cjolowicz
Changes to the Cookiecutter
This section lists changes to the Cookiecutter that don't affect generated projects.
👷 Continuous Integration
- Add label
skip-changelog
for excluding PRs from release notes (#675) @cjolowicz
📚 Documentation
- Update CONTRIBUTORS.rst (#948) @cjolowicz
- Update link on poetry version constraints (#919) @staticdev
- Fix broken link to pip docs in User Guide (#887) @cjolowicz
- Remove obsolete note on
mypy --ignore-missing-imports
from User Guide (#878) @cjolowicz
📦 Dependencies
Expand
- Bump actions/cache from 2.1.5 to 2.1.6 (#913) @dependabot
- Bump cookiecutter from 1.7.2 to 1.7.3 in /.github/workflows (#907) @dependabot
- Bump nox from 2020.12.31 to 2021.6.12 in /.github/workflows (#933) @dependabot
- Bump nox-poetry from 0.8.4 to 0.8.5 in /.github/workflows (#894) @dependabot
- Bump nox-poetry from 0.8.5 to 0.8.6 in /.github/workflows (#934) @dependabot
- Bump pip from 21.0.1 to 21.1 in /.github/workflows (#884) @dependabot
- Bump pip from 21.1 to 21.1.1 in /.github/workflows (#895) @dependabot
- Bump pip from 21.1.1 to 21.1.2 in /.github/workflows (#910) @dependabot
- Bump pre-commit from 2.12.0 to 2.12.1 in /.github/workflows (#882) @dependabot
- Bump pre-commit from 2.12.1 to 2.13.0 in /.github/workflows (#911) @dependabot
- Bump sphinx from 3.5.4 to 4.0.2 in /docs (#909) @dependabot
- Bump virtualenv from 20.4.3 to 20.4.4 in /.github/workflows (#883) @dependabot
- Bump virtualenv from 20.4.4 to 20.4.6 in /.github/workflows (#903) @dependabot
- Bump virtualenv from 20.4.6 to 20.4.7 in /.github/workflows (#912) @dependabot
2021.4.15
Overview of Changes
This release contains various minor improvements to automated checks.
Changes
This section lists changes affecting generated projects.
🚨 Testing
- Configure darglint to allow long docstrings without signatures (#871) @cjolowicz
- Configure flake8-rst-docstrings for Sphinx (#876) @cjolowicz
- Print full report in safety session (#872) @cjolowicz
- Simplify mypy.ini using the strict setting (#869) @cjolowicz
- Improve error message when nox-poetry is not installed (#875) @cjolowicz
📦 Dependencies
- Bump actions/cache from v2.1.4 to v2.1.5 (#853) @cjolowicz
- Bump actions/download-artifact from v2.0.8 to v2.0.9 (#857) @cjolowicz
- Bump actions/setup-python from v2.2.1 to v2.2.2 (#866) @cjolowicz
- Bump actions/upload-artifact from v2.2.2 to v2.2.3 (#858) @cjolowicz
- Bump codecov/codecov-action from v1.2.2 to v1.3.1 (#833) @cjolowicz
- Bump codecov/codecov-action from v1.3.1 to v1.3.2 (#861) @cjolowicz
- Bump darglint from 1.7.0 to 1.8.0 (#862) @cjolowicz
- Bump flake8 from 3.8.4 to 3.9.0 (#829) @cjolowicz
- Bump flake8-bugbear from 21.3.2 to 21.4.3 (#845) @cjolowicz
- Bump flake8-docstrings from 1.5.0 to 1.6.0 (#842) @cjolowicz
- Bump nox-poetry from 0.8.2 to 0.8.4 in /.github/workflows (#827) @cjolowicz
- Bump poetry from 1.1.5 to 1.1.6 in /.github/workflows (#865) @cjolowicz
- Bump pre-commit from 2.11.1 to 2.12.0 (#856) @cjolowicz
- Bump pytest from 6.2.2 to 6.2.3 (#863) @cjolowicz
- Bump release-drafter/release-drafter from v5.14.0 to v5.15.0 (#832) @cjolowicz
- Bump sphinx from 3.5.2 to 3.5.3 (#838) @cjolowicz
- Bump sphinx from 3.5.2 to 3.5.3 in /docs (#840) @cjolowicz
- Bump sphinx from 3.5.3 to 3.5.4 (#854) @cjolowicz
- Bump sphinx from 3.5.3 to 3.5.4 in /docs (#855) @cjolowicz
- Bump sphinx-autobuild from 2020.9.1 to 2021.3.14 (#828) @cjolowicz
- Bump sphinx-click from 2.6.0 to 2.7.1 (#839) @cjolowicz
- Bump sphinx-click from 2.6.0 to 2.7.1 in /docs (#841) @cjolowicz
- Bump sphinx-rtd-theme from 0.5.1 to 0.5.2 (#859) @cjolowicz
- Bump sphinx-rtd-theme from 0.5.1 to 0.5.2 in /docs (#860) @cjolowicz
- Bump typeguard from 2.11.1 to 2.12.0 (#844) @cjolowicz
- Bump urllib3 from 1.26.3 to 1.26.4 (#843) @cjolowicz
- Bump virtualenv from 20.4.2 to 20.4.3 in /.github/workflows (#834) @cjolowicz
- Upgrade subdependencies (#867) @cjolowicz
Changes to the Cookiecutter
This section lists changes to the Cookiecutter that don't affect generated projects.
🚨 Testing
- Check for dead links in documentation (#699) @oncleben31
👷 Continuous Integration
- Switch instance repository to main branch (#868) @cjolowicz
📚 Documentation
- Include Labeler workflow in "Files and Directories" table in User Guide (#874) @cjolowicz
- Update User Guide to reflect recent changes in mypy.ini (#873) @cjolowicz
📦 Dependencies
- Bump actions/cache from v2.1.4 to v2.1.5 (#851) @dependabot
- Bump actions/setup-python from v2.2.1 to v2.2.2 (#852) @dependabot
- Bump nox-poetry from 0.8.2 to 0.8.4 in /.github/workflows (#826) @dependabot
- Bump poetry from 1.1.5 to 1.1.6 in /.github/workflows (#864) @dependabot
- Bump pre-commit from 2.11.1 to 2.12.0 in /.github/workflows (#849) @dependabot
- Bump release-drafter/release-drafter from v5.14.0 to v5.15.0 (#830) @dependabot
- Bump sphinx from 3.5.2 to 3.5.3 in /docs (#837) @dependabot
- Bump sphinx from 3.5.3 to 3.5.4 in /docs (#850) @dependabot
- Bump sphinx-autobuild from 2020.9.1 to 2021.3.14 in /docs (#824) @dependabot
- Bump virtualenv from 20.4.2 to 20.4.3 in /.github/workflows (#831) @dependabot
2021.3.14
Overview of Changes
This release allows generated projects to choose a license. Supported licenses are MIT, Apache-2.0, and GPL-3.0.
Changes
This section lists changes affecting generated projects.
🚀 Features
🚨 Testing
- Use session decorator from nox-poetry (#769) @cjolowicz
📚 Documentation
- Fix reference to master in Codecov link on README (#788) @cjolowicz
📦 Dependencies
- Bump actions/cache from v2.1.3 to v2.1.4 (#780) @cjolowicz
- Bump codecov/codecov-action from v1.2.1 to v1.2.2 (#815) @cjolowicz
- Bump darglint from 1.5.8 to 1.6.0 (#783) @cjolowicz
- Bump darglint from 1.6.0 to 1.7.0 (#810) @cjolowicz
- Bump flake8-bugbear from 20.11.1 to 21.3.2 (#808) @cjolowicz
- Bump jinja2 from 2.11.2 to 2.11.3 (#801) @cjolowicz
- Bump mypy from 0.800 to 0.812 (#807) @cjolowicz
- Bump nox-poetry from 0.7.1 to 0.8.1 in /.github/workflows (#768) @cjolowicz
- Bump nox-poetry from 0.8.1 to 0.8.2 in /.github/workflows (#819) @cjolowicz
- Bump pip from 21.0 to 21.0.1 in /.github/workflows (#784) @cjolowicz
- Bump poetry from 1.1.4 to 1.1.5 in /.github/workflows (#804) @cjolowicz
- Bump pre-commit from 2.10.0 to 2.10.1 (#778) @cjolowicz
- Bump pre-commit from 2.10.1 to 2.11.1 (#813) @cjolowicz
- Bump pygments from 2.7.4 to 2.8.0 (#775) @cjolowicz
- Bump pygments from 2.8.0 to 2.8.1 (#814) @cjolowicz
- Bump pypa/gh-action-pypi-publish from v1.4.1 to v1.4.2 (#777) @cjolowicz
- Bump pyyaml from 5.3.1 to 5.4.1 (#802) @cjolowicz
- Bump release-drafter/release-drafter from v5.13.0 to v5.14.0 (#776) @cjolowicz
- Bump reorder-python-imports from 2.3.6 to 2.4.0 (#779) @cjolowicz
- Bump sphinx from 3.4.3 to 3.5.1 (#786) @cjolowicz
- Bump sphinx from 3.4.3 to 3.5.1 in /docs (#774) @cjolowicz
- Bump sphinx from 3.5.1 to 3.5.2 (#812) @cjolowicz
- Bump sphinx from 3.5.1 to 3.5.2 in /docs (#803) @cjolowicz
- Bump sphinx-click from 2.5.0 to 2.6.0 (#809) @cjolowicz
- Bump sphinx-click from 2.5.0 to 2.6.0 in /docs (#805) @cjolowicz
- Bump typeguard from 2.10.0 to 2.11.1 (#785) @cjolowicz
- Bump virtualenv from 20.4.0 to 20.4.2 in /.github/workflows (#781) @cjolowicz
- Bump xdoctest from 0.15.3 to 0.15.4 (#782) @cjolowicz
- Update subdependencies (#816) @cjolowicz
Changes to the Cookiecutter
This section lists changes to the Cookiecutter that don't affect generated projects.
👷 Continuous Integration
- Use main branch in GA workflows (#806) @cjolowicz
- Default to main branch in release tool (#789) @cjolowicz
- Fix release automation for Cookiecutter template (#759) @cjolowicz
📦 Dependencies
- Bump actions/cache from v2.1.3 to v2.1.4 (#765) @dependabot
- Bump nox-poetry from 0.7.1 to 0.8.1 in /.github/workflows (#766) @dependabot
- Bump nox-poetry from 0.8.1 to 0.8.2 in /.github/workflows (#820) @dependabot
- Bump pip from 21.0 to 21.0.1 in /.github/workflows (#760) @dependabot
- Bump poetry from 1.1.4 to 1.1.5 in /.github/workflows (#798) @dependabot
- Bump pre-commit from 2.10.0 to 2.10.1 in /.github/workflows (#767) @dependabot
- Bump pre-commit from 2.10.1 to 2.11.0 in /.github/workflows (#800) @dependabot
- Bump pre-commit from 2.11.0 to 2.11.1 in /.github/workflows (#811) @dependabot
- Bump release-drafter/release-drafter from v5.13.0 to v5.14.0 (#770) @dependabot
- Bump sphinx from 3.4.3 to 3.5.1 in /docs (#772) @dependabot
- Bump sphinx from 3.5.1 to 3.5.2 in /docs (#799) @dependabot
- Bump virtualenv from 20.4.0 to 20.4.2 in /.github/workflows (#764) @dependabot
2021.1.29
Overview of Changes
This is a maintenance release.
Changes
This section lists changes affecting generated projects.
📦 Dependencies
- Bump actions/download-artifact from v2.0.5 to v2.0.6 (#680) @cjolowicz
- Bump actions/download-artifact from v2.0.6 to v2.0.8 (#727) @cjolowicz
- Bump actions/setup-python from v2.1.4 to v2.2.1 (#748) @cjolowicz
- Bump actions/upload-artifact from v2.2.0 to v2.2.1 (#681) @cjolowicz
- Bump actions/upload-artifact from v2.2.1 to v2.2.2 (#752) @cjolowicz
- Bump codecov/codecov-action from v1.0.14 to v1.0.15 (#682) @cjolowicz
- Bump codecov/codecov-action from v1.0.15 to v1.2.1 (#725) @cjolowicz
- Bump coverage from 5.3 to 5.3.1 (#743) @cjolowicz
- Bump coverage from 5.3.1 to 5.4 (#744) @cjolowicz
- Bump crazy-max/ghaction-github-labeler from v3.1.0 to v3.1.1 (#704) @cjolowicz
- Bump darglint from 1.5.5 to 1.5.8 (#685) @cjolowicz
- Bump flake8-bugbear from 20.1.4 to 20.11.1 (#686) @cjolowicz
- Bump mypy from 0.790 to 0.800 (#751) @cjolowicz
- Bump nox from 2020.8.22 to 2020.12.31 in /.github/workflows (#713) @cjolowicz
- Bump nox-poetry from 0.5.0 to 0.7.1 in /.github/workflows (#721) @cjolowicz
- Bump pip from 20.2.4 to 21.0 in /.github/workflows (#739) @cjolowicz
- Bump poetry from 1.1.2 to 1.1.4 in /.github/workflows (#733) @cjolowicz
- Bump pre-commit from 2.8.2 to 2.9.3 (#732) @cjolowicz
- Bump pre-commit from 2.9.3 to 2.10.0 (#753) @cjolowicz
- Bump pre-commit-hooks from 3.3.0 to 3.4.0 (#749) @cjolowicz
- Bump py from 1.9.0 to 1.10.0 (#741) @cjolowicz
- Bump pygments from 2.7.2 to 2.7.4 (#723) @cjolowicz
- Bump pytest from 6.1.2 to 6.2.2 (#742) @cjolowicz
- Bump release-drafter/release-drafter from v5.12.1 to v5.13.0 (#728) @cjolowicz
- Bump safety from 1.9.0 to 1.10.3 (#746) @cjolowicz
- Bump sphinx from 3.3.1 to 3.4.3 (#754) @cjolowicz
- Bump sphinx from 3.3.1 to 3.4.3 in /docs (#724) @cjolowicz
- Bump sphinx-rtd-theme from 0.5.0 to 0.5.1 (#745) @cjolowicz
- Bump sphinx-rtd-theme from 0.5.0 to 0.5.1 in /docs (#726) @cjolowicz
- Bump typeguard from 2.9.1 to 2.10.0 (#652) @cjolowicz
- Bump virtualenv from 20.1.0 to 20.2.1 in /.github/workflows (#684) @cjolowicz
- Bump virtualenv from 20.2.1 to 20.4.0 in /.github/workflows (#740) @cjolowicz
- Bump xdoctest from 0.15.0 to 0.15.2 (#747) @cjolowicz
- Bump xdoctest from 0.15.2 to 0.15.3 (#755) @cjolowicz
Changes to the Cookiecutter
This section lists changes to the Cookiecutter that don't affect generated projects.
👷 Continuous Integration
- Add tools to automate Cookiecutter releases (#674) @cjolowicz
📚 Documentation
- Remove Quickstart from README (#673) @cjolowicz
📦 Dependencies
- Bump actions/setup-python from v2.1.4 to v2.2.0 (#705) @dependabot
- Bump actions/setup-python from v2.2.0 to v2.2.1 (#707) @dependabot
- Bump crazy-max/ghaction-github-labeler from v3.1.0 to v3.1.1 (#703) @dependabot
- Bump nox from 2020.8.22 to 2020.12.31 in /.github/workflows (#710) @dependabot
- Bump nox-poetry from 0.5.0 to 0.6.0 in /.github/workflows (#693) @dependabot
- Bump nox-poetry from 0.6.0 to 0.7.1 in /.github/workflows (#719) @dependabot
- Bump pip from 20.2.4 to 20.3 in /.github/workflows (#690) @dependabot
- Bump pip from 20.3 to 20.3.1 in /.github/workflows (#692) @dependabot
- Bump pip from 20.3.1 to 21.0 in /.github/workflows (#738) @dependabot
- Bump poetry from 1.1.2 to 1.1.4 in /.github/workflows (#637) @dependabot
- Bump pre-commit from 2.8.2 to 2.9.0 in /.github/workflows (#678) @dependabot
- Bump pre-commit from 2.9.0 to 2.9.2 in /.github/workflows (#687) @dependabot
- Bump pre-commit from 2.9.2 to 2.9.3 in /.github/workflows (#697) @dependabot
- Bump pre-commit from 2.9.3 to 2.10.0 in /.github/workflows (#750) @dependabot
- Bump release-drafter/release-drafter from v5.12.1 to v5.13.0 (#709) @dependabot
- Bump sphinx from 3.3.1 to 3.4.3 in /docs (#716) @dependabot
- Bump virtualenv from 20.1.0 to 20.2.0 in /.github/workflows (#677) @dependabot
- Bump virtualenv from 20.2.0 to 20.2.1 in /.github/workflows (#679) @dependabot
- Bump virtualenv from 20.2.1 to 20.4.0 in /.github/workflows (#734) @dependabot