v3.6.0

Compare Source

• Fix: Mark test scripts with Bash'isms to be run via Bash
• Add option to fetch tags even if fetch-depth > 0

v3.5.3

Compare Source

• Fix: Checkout fail in self-hosted runners when faulty submodule are checked-in
• Fix typos found by codespell
• Add support for sparse checkouts

v4.9.1

Compare Source

What's Changed

• Add workflow file for publishing releases to immutable action package by @​aparnajyothi-y in #​1084

Full Changelog: actions/setup-python@v4...v4.9.1

v4.9.0

Compare Source

What's Changed

• Upgrade actions/cache to 4.0.3 by @​priya-kinthali in #​1073
  In scope of this release we updated actions/cache package to ensure continued support and compatibility, as older versions of the package are now deprecated. For more information please refer to the toolkit/cache.

Full Changelog: actions/setup-python@v4.8.0...v4.9.0

v4.8.0

Compare Source

What's Changed

In scope of this release we added support for GraalPy (#​694). You can use this snippet to set up GraalPy:

steps:
- uses: actions/checkout@v4
- uses: actions/setup-python@v4 
  with:
    python-version: 'graalpy-22.3' 
- run: python my_script.py

Besides, the release contains such changes as:

• Trim python version when reading from file by @​FerranPares in #​628
• Use non-deprecated versions in examples by @​jeffwidman in #​724
• Change deprecation comment to past tense by @​jeffwidman in #​723
• Bump @​babel/traverse from 7.9.0 to 7.23.2 by @​dependabot in #​743
• advanced-usage.md: Encourage the use actions/checkout@​v4 by @​cclauss in #​729
• Examples now use checkout@​v4 by @​simonw in #​738
• Update actions/checkout to v4 by @​dmitry-shibanov in #​761

New Contributors

• @​FerranPares made their first contribution in #​628
• @​timfel made their first contribution in #​694
• @​jeffwidman made their first contribution in #​724

Full Changelog: actions/setup-python@v4...v4.8.0

v4.7.1

Compare Source

What's Changed

• Bump word-wrap from 1.2.3 to 1.2.4 by @​dependabot in #​702
• Add range validation for toml files by @​dmitry-shibanov in #​726

Full Changelog: actions/setup-python@v4...v4.7.1

v4.7.0

Compare Source

In scope of this release, the support for reading python version from pyproject.toml was added (#​669).

      - name: Setup Python
        uses: actions/setup-python@v4
        with:
          python-version-file: pyproject.toml

Besides, it includes such changes as:

• Bump tough-cookie and @​azure/ms-rest-js by @​dependabot in #​697
• Bump semver from 7.3.8 to 7.5.2 by @​dependabot in #​692
• Fix typos found by codespell by @​DimitriPapadopoulos in #​650

New Contributors

• @​dariocurr made their first contribution in #​669
• @​DimitriPapadopoulos made their first contribution in #​650

Full Changelog: actions/setup-python@v4...v4.7.0

v3.2.1

Compare Source

What's Changed

This fixes the include-hidden-files input introduced in https://github.com/actions/upload-artifact/releases/tag/v3.2.0

• Ensure hidden files input is used by @​joshmgross in #​609

Full Changelog: actions/upload-artifact@v3.2.0...v3.2.1

v3.2.0

Compare Source

Notice: Breaking Changes ⚠️

We will no longer include hidden files and folders by default in the upload-artifact action of this version. This reduces the risk that credentials are accidentally uploaded into artifacts. Customers who need to continue to upload these files can use a new option, include-hidden-files, to continue to do so.

See "Notice of upcoming deprecations and breaking changes in GitHub Actions runners" changelog and this issue for more details.

What's Changed

• V3 backport: Exclude hidden files by default by @​SrRyan in #​604

Full Changelog: actions/upload-artifact@v3.1.3...v3.2.0

v3.1.3

Compare Source

What's Changed

• chore(github): remove trailing whitespaces by @​ljmf00 in #​313
• Bump @​actions/artifact version to v1.1.2 by @​bethanyj28 in #​436

Full Changelog: actions/upload-artifact@v3...v3.1.3

v23.12.1

Compare Source

Packaging

• Fixed a bug that included dependencies from the d extra by default (#​4108)

v23.12.0

Compare Source

Highlights

It's almost 2024, which means it's time for a new edition of Black's stable style!
Together with this release, we'll put out an alpha release 24.1a1 showcasing the draft
2024 stable style, which we'll finalize in the January release. Please try it out and
share your feedback.

This release (23.12.0) will still produce the 2023 style. Most but not all of the
changes in --preview mode will be in the 2024 stable style.

Stable style

• Fix bug where # fmt: off automatically dedents when used with the --line-ranges
  option, even when it is not within the specified line range. (#​4084)
• Fix feature detection for parenthesized context managers (#​4104)

Preview style

• Prefer more equal signs before a break when splitting chained assignments (#​4010)
• Standalone form feed characters at the module level are no longer removed (#​4021)
• Additional cases of immediately nested tuples, lists, and dictionaries are now
  indented less (#​4012)
• Allow empty lines at the beginning of all blocks, except immediately before a
  docstring (#​4060)
• Fix crash in preview mode when using a short --line-length (#​4086)
• Keep suites consisting of only an ellipsis on their own lines if they are not
  functions or class definitions (#​4066) (#​4103)

Configuration

• --line-ranges now skips Black's internal stability check in --safe mode. This
  avoids a crash on rare inputs that have many unformatted same-content lines. (#​4034)

Packaging

• Upgrade to mypy 1.7.1 (#​4049) (#​4069)
• Faster compiled wheels are now available for CPython 3.12 (#​4070)

Integrations

• Enable 3.12 CI (#​4035)
• Build docker images in parallel (#​4054)
• Build docker images with 3.12 (#​4055)

v23.11.0

Compare Source

Highlights

• Support formatting ranges of lines with the new --line-ranges command-line option
  (#​4020)

Stable style

• Fix crash on formatting bytes strings that look like docstrings (#​4003)
• Fix crash when whitespace followed a backslash before newline in a docstring (#​4008)
• Fix standalone comments inside complex blocks crashing Black (#​4016)
• Fix crash on formatting code like await (a ** b) (#​3994)
• No longer treat leading f-strings as docstrings. This matches Python's behaviour and
  fixes a crash (#​4019)

Preview style

• Multiline dicts and lists that are the sole argument to a function are now indented
  less (#​3964)
• Multiline unpacked dicts and lists as the sole argument to a function are now also
  indented less (#​3992)
• In f-string debug expressions, quote types that are visible in the final string are
  now preserved (#​4005)
• Fix a bug where long case blocks were not split into multiple lines. Also enable
  general trailing comma rules on case blocks (#​4024)
• Keep requiring two empty lines between module-level docstring and first function or
  class definition (#​4028)
• Add support for single-line format skip with other comments on the same line (#​3959)

Configuration

• Consistently apply force exclusion logic before resolving symlinks (#​4015)
• Fix a bug in the matching of absolute path names in --include (#​3976)

Performance

• Fix mypyc builds on arm64 on macOS (#​4017)

Integrations

• Black's pre-commit integration will now run only on git hooks appropriate for a code
  formatter (#​3940)

v23.10.1

Compare Source

Highlights

• Maintenance release to get a fix out for GitHub Action edge case (#​3957)

Preview style

• Fix merging implicit multiline strings that have inline comments (#​3956)
• Allow empty first line after block open before a comment or compound statement (#​3967)

Packaging

• Change Dockerfile to hatch + compile black (#​3965)

Integrations

• The summary output for GitHub workflows is now suppressible using the summary
  parameter. (#​3958)
• Fix the action failing when Black check doesn't pass (#​3957)

Documentation

• It is known Windows documentation CI is broken
  #​3968

v23.10.0

Compare Source

Stable style

• Fix comments getting removed from inside parenthesized strings (#​3909)

Preview style

• Fix long lines with power operators getting split before the line length (#​3942)
• Long type hints are now wrapped in parentheses and properly indented when split across
  multiple lines (#​3899)
• Magic trailing commas are now respected in return types. (#​3916)
• Require one empty line after module-level docstrings. (#​3932)
• Treat raw triple-quoted strings as docstrings (#​3947)

Configuration

• Fix cache versioning logic when BLACK_CACHE_DIR is set (#​3937)

Parser

• Fix bug where attributes named type were not accepted inside match statements
  (#​3950)
• Add support for PEP 695 type aliases containing lambdas and other unusual expressions
  (#​3949)

Output

• Black no longer attempts to provide special errors for attempting to format Python 2
  code (#​3933)
• Black will more consistently print stacktraces on internal errors in verbose mode
  (#​3938)

Integrations

• The action output displayed in the job summary is now wrapped in Markdown (#​3914)

v23.9.1

Compare Source

Due to various issues, the previous release (23.9.0) did not include compiled mypyc
wheels, which make Black significantly faster. These issues have now been fixed, and
this release should come with compiled wheels once again.

There will be no wheels for Python 3.12 due to a bug in mypyc. We will provide 3.12
wheels in a future release as soon as the mypyc bug is fixed.

Packaging

• Upgrade to mypy 1.5.1 (#​3864)

Performance

• Store raw tuples instead of NamedTuples in Black's cache, improving performance and
  decreasing the size of the cache (#​3877)

v23.9.0

Compare Source

Preview style

• More concise formatting for dummy implementations (#​3796)
• In stub files, add a blank line between a statement with a body (e.g an
  if sys.version_info > (3, x):) and a function definition on the same level (#​3862)
• Fix a bug whereby spaces were removed from walrus operators within subscript(#​3823)

Configuration

• Black now applies exclusion and ignore logic before resolving symlinks (#​3846)

Performance

• Avoid importing IPython if notebook cells do not contain magics (#​3782)
• Improve caching by comparing file hashes as fallback for mtime and size (#​3821)

Blackd

• Fix an issue in blackd with single character input (#​3558)

Integrations

• Black now has an
  official pre-commit mirror. Swapping
  https://github.com/psf/black to https://github.com/psf/black-pre-commit-mirror in
  your .pre-commit-config.yaml will make Black about 2x faster (#​3828)
• The .black.env folder specified by ENV_PATH will now be removed on the completion
  of the GitHub Action (#​3759)

v23.7.0

Compare Source

Highlights

• Runtime support for Python 3.7 has been removed. Formatting 3.7 code will still be
  supported until further notice (#​3765)

Stable style

• Fix a bug where an illegal trailing comma was added to return type annotations using
  PEP 604 unions (#​3735)
• Fix several bugs and crashes where comments in stub files were removed or mishandled
  under some circumstances (#​3745)
• Fix a crash with multi-line magic comments like type: ignore within parentheses
  (#​3740)
• Fix error in AST validation when Black removes trailing whitespace in a type comment
  (#​3773)

Preview style

• Implicitly concatenated strings used as function args are no longer wrapped inside
  parentheses (#​3640)
• Remove blank lines between a class definition and its docstring (#​3692)

Configuration

• The --workers argument to Black can now be specified via the BLACK_NUM_WORKERS
  environment variable (#​3743)
• .pytest_cache, .ruff_cache and .vscode are now excluded by default (#​3691)
• Fix Black not honouring pyproject.toml settings when running --stdin-filename
  and the pyproject.toml found isn't in the current working directory (#​3719)
• Black will now error if exclude and extend-exclude have invalid data types in
  pyproject.toml, instead of silently doing the wrong thing (#​3764)

Packaging

• Upgrade mypyc from 0.991 to 1.3 (#​3697)
• Remove patching of Click that mitigated errors on Python 3.6 with LANG=C (#​3768)

Parser

• Add support for the new PEP 695 syntax in Python 3.12 (#​3703)

Performance

• Speed up Black significantly when the cache is full (#​3751)
• Avoid importing IPython in a case where we wouldn't need it (#​3748)

Output

• Use aware UTC datetimes internally, avoids deprecation warning on Python 3.12 (#​3728)
• Change verbose logging to exactly mirror Black's logic for source discovery (#​3749)

Blackd

• The blackd argument parser now shows the default values for options in their help
  text (#​3712)

Integrations

• Black is now tested with
  PYTHONWARNDEFAULTENCODING = 1
  (#​3763)
• Update GitHub Action to display black output in the job summary (#​3688)

Documentation

• Add a CITATION.cff file to the root of the repository, containing metadata on how to
  cite this software (#​3723)
• Update the classes and exceptions documentation in Developer reference to match
  the latest code base (#​3755)

v3.1.6

Compare Source

#Full Changelog: codecov/codecov-action@v3.1.5...v3.1.6

v3.1.5

Compare Source

What's Changed

• action.yml: Update to Node.js 20 by @​hallabro in #​1228

v3.31.0

Compare Source

Feat

• commitizen: document '--' double dash in '--help'

Fix

• commit: avoid warnings with 'always_signoff' configuration
• commit: resolve 'always_signoff' configuration and '-s' CLI issues

v3.30.1

Compare Source

Refactor

• cli: replace magic number 0 with ExitCode.EXPECTED_EXIT
• defaults: disallow style as None
• cz_customize: return empty string for info, example, schema and schema_pattern if not provided

v3.30.0

Compare Source

Feat

• commands/commit: add force-edit functionality after answering questions

Refactor

• remove redundant return None

v3.29.1

Compare Source

Fix

• changelog: Factorized TAG_FORMAT_REGEXES
• changelog: Handle tag format without version pattern
• changelog: handle custom tag_format in changelog generation

Refactor

• Use format strings

v3.29.0

Compare Source

Feat

• bump: add functionality to write the next version to stdout

v3.28.0

Compare Source

Feat

• add argument to limit length of commit message in checks

v3.27.0

Compare Source

Feat

• config_files: add support for "cz.toml" config file

v3.26.2

Compare Source

Fix

• base.py: add encoding when open changlelog_file

v3.26.1

Compare Source

Fix

• cli/commands: add description for subcommands

Refactor

• KNOWN_SCHEMES: replace set comprehension for list comprehension
• tests/commands: move "other" tests for the correspondent file

v3.26.0

Compare Source

Feat

• ci/cd: automates the generation of CLI screenshots

v3.25.0

Compare Source

Feat

• add an argument to limit the length of commit message

Fix

• strip the commit message for calculating length
• resolve test error by removing defaults

Refactor

• commands/commit: replace comparison with chained comparison
• check the length in Commit instead of Commitizen

v3.24.0

Compare Source

Feat

• schemes: adds support for SemVer 2.0 (dot in pre-releases) (fix #​1025) (#​1072)

v3.23.0

Compare Source

Feat

• bump: version_files now support glob patterns (fix #​1067) (#​1070)

v3.22.0

Compare Source

Feat

• cli: add config option to specify config file path

v3.21.3

Compare Source

Refactor

• defaults: move cz_conventional_commit defaults out of defaults.py

v3.21.2

Compare Source

Fix

• commitizen/git.py,-tests/test_git.py: Resolve tempfile path spaces issue in git commit function

v3.21.1

Compare Source

Fix

• command-init: "cz init" should list existing tag in reverse order

v3.21.0

Compare Source

Feat

• commit: add retry_after_failure config option and --no-retry flag

Refactor

• utils: convert git project root to posix path for backup file name
• commit: use Optional[str] instead of str | None
• commit: remove unused tempfile import
• git-hooks: make git hooks use get_backup_file_path
• utils: move backup path creation to utils

v3.20.0

Compare Source

Feat

• changelog: expose commits sha1, author and author_email in changelog tree (fix #​987) (#​1013)

v3.19.0

Compare Source

Feat

• changelog: adds a changelog_release_hook called for each release in the changelog (#​1018)

v3.18.4

Compare Source

Fix

• changelog: include latest change when dry run and incremental

v3.18.3

Compare Source

Fix

• warnings: all warnings should go to stdout

v3.18.2

Compare Source

Fix

• git: force the default git locale on methods relying on parsing the output (#​1012)

v3.18.1

Compare Source

Fix

• changelog: changelog hook was not called on dry run

v3.18.0

Compare Source

Feat

• changelog: changelog_message_build_hook can now generate multiple changelog entries from a single commit (#​1003)

v3.17.2

Compare Source

Fix

• changelog: ensure changelog_message_builder_hook can access and modify change_type (#​1002)

v3.17.1

Compare Source

Fix

• bump: pre and post bump hooks were failing when an increment was provided (fix #​1004)

v3.17.0

Compare Source

Feat

• changelog: changelog_message_build_hook can remove message by returning a falsy value

v3.16.0

Compare Source

Feat

• commands: add bump --exact

Fix

• bump: change --exact-increment to --increment-mode
• bump: only get and validate commits if increment is not provided
• Improve type annotations

v3.15.0

Compare Source

Feat

• bump: functionality to add build-metadata to version string

v3.14.1

Compare Source

Fix

• bump: remove unused method
• scm: only search tags that are reachable by the current commit

v3.14.0

Compare Source

Feat

• properly bump versions between prereleases (#​799)

v3.13.0

Compare Source

Feat

• commands-bump: automatically create annotated tag if message is given
• add tag message argument to cli
• git: add get tag message function
• add custom message to annotated git tag

Fix

• test-bump-command: typo in --annotated-tag option inside test
• commitizen-git: add quotes for tag message

Refactor

• commands-bump: make changelog variable in 1 line
• commands-bump: cast str to bool

v3.12.0

Feat

• formats: expose some new customizable changelog formats on the commitizen.changelog_format endpoint (Textile, AsciiDoc and RestructuredText)
• template: add changelog --export-template command
• template: allow to override the template from cli, configuration and plugins
• cli.py: Added support for extra git CLI args after -- separator for cz commit command

Fix

• filename: ensure file_name can be passed to changelog from bump command

Refactor

• git.py: Removed 'extra_args' from git.commit
• extra_args: Fixed broken code due to rebase and finalized tests
• Code Review - round 1 changes
• Commit: Added deprecation on git signoff mechanic

v3.10.1

Compare Source

Fix

• bump: add bump support with custom type + scope + exclamation mark
• bump: version bumping

v3.10.0

Compare Source

Feat

• Drop support for Python 3.7 (#​858)

v3.9.1

Compare Source

Fix

• conf: handle parse error when init (#​856)

v3.9.0

Compare Source

Feat

• commands: add arg of cz commit to execute git add

Fix

• tests: modify the arg of commit from add to all
• commitizen: Modify the function of the arg a of commit from git add all to git add update

Refactor

• commitizen: add return type hint of git add function

v3.8.2

Compare Source

Refactor

• provider: split provider code and related tests into individual files for maintainability (#​830)

v3.8.1

Compare Source

Fix

• add sponsors to README

v3.8.0

Compare Source

Feat

• defaults.py: add always_signoff config option for commits

v3.7.1

Compare Source

Fix

• empty error on bump failure

v3.7.0

Compare Source

Feat

• provider: add npm2 provider to update package.json, package-lock.json, and npm-shrinkwrap.json

Fix

• provider: fix npm version provider to update package-lock.json and npm-shrinkwrap.json if they exist
• provider: fix npm provider to update package-lock.json and npm-shrinkwrap.json if they exist
• test: pass correct type to get_package_version tests
• tests: completed test coverage for npm2

v3.6.0

Compare Source

Feat

• changelog.py: add encoding to get_metadata
• unicode: add unicode support

Fix

• add missing encoding parameter
• out.py: `TextIOWra