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 release 22.10.0 #3311

Merged
merged 1 commit into from Oct 6, 2022
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
72 changes: 45 additions & 27 deletions CHANGES.md
Expand Up @@ -6,42 +6,22 @@

<!-- Include any especially major or disruptive changes here -->

- Runtime support for Python 3.6 has been removed. Formatting 3.6 code will still be
supported until further notice.

### Stable style

<!-- Changes that affect Black's stable style -->

- Fix a crash when `# fmt: on` is used on a different block level than `# fmt: off`
(#3281)

### Preview style

<!-- Changes that affect Black's preview style -->

- Fix a crash when formatting some dicts with parenthesis-wrapped long string keys
(#3262)

### Configuration

<!-- Changes to how Black can be configured -->

- `.ipynb_checkpoints` directories are now excluded by default (#3293)
- Add `--skip-source-first-line` / `-x` option to ignore the first line of source code
while formatting (#3299)

### Packaging

<!-- Changes to how Black is packaged, such as dependency requirements -->

- Executables made with PyInstaller will no longer crash when formatting several files
at once on macOS. Native x86-64 executables for macOS are available once again.
(#3275)
- Hatchling is now used as the build backend. This will not have any effect for users
who install Black with its wheels from PyPI. (#3233)
- Faster compiled wheels are now available for CPython 3.11 (#3276)

### Parser

<!-- Changes to the parser or to version autodetection -->
Expand All @@ -56,22 +36,61 @@

### _Blackd_

- Windows style (CRLF) newlines will be preserved (#3257).
<!-- Changes to blackd -->

### Integrations

<!-- For example, Docker, GitHub Actions, pre-commit, editors -->

- Update GitHub Action to support formatting of Jupyter Notebook files via a `jupyter`
option (#3282)
- Update GitHub Action to support use of version specifiers (e.g. `<23`) for Black
version (#3265)

### Documentation

<!-- Major changes to documentation and policies. Small docs changes
don't need a changelog entry. -->

## 22.10.0

### Highlights

- Runtime support for Python 3.6 has been removed. Formatting 3.6 code will still be
supported until further notice.

### Stable style

- Fix a crash when `# fmt: on` is used on a different block level than `# fmt: off`
(#3281)

### Preview style

- Fix a crash when formatting some dicts with parenthesis-wrapped long string keys
(#3262)

### Configuration

- `.ipynb_checkpoints` directories are now excluded by default (#3293)
- Add `--skip-source-first-line` / `-x` option to ignore the first line of source code
while formatting (#3299)

### Packaging

- Executables made with PyInstaller will no longer crash when formatting several files
at once on macOS. Native x86-64 executables for macOS are available once again.
(#3275)
- Hatchling is now used as the build backend. This will not have any effect for users
who install Black with its wheels from PyPI. (#3233)
- Faster compiled wheels are now available for CPython 3.11 (#3276)

### _Blackd_

- Windows style (CRLF) newlines will be preserved (#3257).

### Integrations

- Vim plugin: add flag (`g:black_preview`) to enable/disable the preview style (#3246)
- Update GitHub Action to support formatting of Jupyter Notebook files via a `jupyter`
option (#3282)
- Update GitHub Action to support use of version specifiers (e.g. `<23`) for Black
version (#3265)

## 22.8.0

### Highlights
Expand Down Expand Up @@ -126,7 +145,6 @@
- Vim plugin: prefix messages with `Black: ` so it's clear they come from Black (#3194)
- Docker: changed to a /opt/venv installation + added to PATH to be available to
non-root users (#3202)
- Vim plugin: add flag (`g:black_preview`) to enable/disable the preview style (#3246)

### Output

Expand Down
2 changes: 1 addition & 1 deletion docs/faq.md
Expand Up @@ -95,7 +95,7 @@ Support for formatting Python 2 code was removed in version 22.0. While we've ma
plans to stop supporting older Python 3 minor versions immediately, their support might
also be removed some time in the future without a deprecation period.

Runtime support for 3.6 was removed in version 22.9.0.
Runtime support for 3.6 was removed in version 22.10.0.

## Why does my linter or typechecker complain after I format my code?

Expand Down
2 changes: 1 addition & 1 deletion docs/integrations/source_version_control.md
Expand Up @@ -7,7 +7,7 @@ Use [pre-commit](https://pre-commit.com/). Once you
```yaml
repos:
- repo: https://github.com/psf/black
rev: 22.8.0
rev: 22.10.0
hooks:
- id: black
# It is recommended to specify the latest version of Python
Expand Down
2 changes: 1 addition & 1 deletion docs/usage_and_configuration/the_basics.md
Expand Up @@ -173,7 +173,7 @@ You can check the version of _Black_ you have installed using the `--version` fl

```console
$ black --version
black, version 22.8.0
black, version 22.10.0
```

An option to require a specific version to be running is also provided.
Expand Down