
This also introduces a script so we can reference the latest version in the example pre-commit configuration in the docs without forgetting to update it when doing a release! Commit history before merge: * document jupyter hook * note minimum version * add check for pre-commit version * use git tag * curl api during ci * parse version from changes file * fixup script * rename variables * Tweak the docs & magical script * fix couple of typos * pin additional dependencies in hook * Add types-PyYAML to lockfile Co-authored-by: Richard Si <63936253+ichard26@users.noreply.github.com>
28 lines
964 B
Markdown
28 lines
964 B
Markdown
# Version control integration
|
|
|
|
Use [pre-commit](https://pre-commit.com/). Once you
|
|
[have it installed](https://pre-commit.com/#install), add this to the
|
|
`.pre-commit-config.yaml` in your repository:
|
|
|
|
```yaml
|
|
repos:
|
|
- repo: https://github.com/psf/black
|
|
rev: 21.7b0
|
|
hooks:
|
|
- id: black
|
|
language_version: python3 # Should be a command that runs python3.6+
|
|
```
|
|
|
|
Feel free to switch out the `rev` value to something else, like another
|
|
[tag/version][black-tags] or even a specific commit. Although we discourage the use of
|
|
branches or other mutable refs since the hook [won't auto update as you may
|
|
expect][pre-commit-mutable-rev].
|
|
|
|
If you want support for Jupyter Notebooks as well, then replace `id: black` with
|
|
`id: black-jupyter` (though note that it's only available from version `21.8b0`
|
|
onwards).
|
|
|
|
[black-tags]: https://github.com/psf/black/tags
|
|
[pre-commit-mutable-rev]:
|
|
https://pre-commit.com/#using-the-latest-version-for-a-repository
|