X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/6b42c2b8c9f9bd666120a2c19b8da509fe477f27..37895f8e50486a0fa581f8fb039e536dc6d0d0e4:/docs/integrations/github_actions.md diff --git a/docs/integrations/github_actions.md b/docs/integrations/github_actions.md index 12bcb21..56b2cdd 100644 --- a/docs/integrations/github_actions.md +++ b/docs/integrations/github_actions.md @@ -24,7 +24,7 @@ jobs: lint: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - uses: psf/black@stable ``` @@ -44,7 +44,9 @@ extra. Installing the extra and including Jupyter Notebook files can be configur `jupyter` (default is `false`). You can also configure the arguments passed to _Black_ via `options` (defaults to -`'--check --diff'`) and `src` (default is `'.'`) +`'--check --diff'`) and `src` (default is `'.'`). Please note that the +[`--check` flag](labels/exit-code) is required so that the workflow fails if _Black_ +finds files that need to be formatted. Here's an example configuration: