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 to python 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