Move coverage configurations to `pyproject.toml` (#3858)

[etc/vim.git] / docs / integrations / github_actions.md

diff --git a/docs/integrations/github_actions.md b/docs/integrations/github_actions.md
index d77b969367897f155671bd38941e6f2db117b493..56b2cdd05868121b1fd75a68f7040b4d35f45ba0 100644 (file)
--- a/docs/integrations/github_actions.md
+++ b/docs/integrations/github_actions.md
@@ -24,7 +24,7 @@ jobs:
   lint:
     runs-on: ubuntu-latest
     steps:
   lint:
     runs-on: ubuntu-latest
     steps:

-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3

       - uses: psf/black@stable
 ```
 
       - uses: psf/black@stable
 ```
 


@@ -39,8 +39,14 @@ or just the version number if you want an exact version. The action defaults to
 latest release available on PyPI. Only versions available from PyPI are supported, so no
 commit SHAs or branch names.
 
 latest release available on PyPI. Only versions available from PyPI are supported, so no
 commit SHAs or branch names.
 

+If you want to include Jupyter Notebooks, _Black_ must be installed with the `jupyter`
+extra. Installing the extra and including Jupyter Notebook files can be configured via
+`jupyter` (default is `false`).
+

 You can also configure the arguments passed to _Black_ via `options` (defaults to
 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:
 
 
 Here's an example configuration:
 


@@ -49,6 +55,7 @@ Here's an example configuration:
   with:
     options: "--check --verbose"
     src: "./src"
   with:
     options: "--check --verbose"
     src: "./src"

+    jupyter: true

     version: "21.5b1"
 ```
 
     version: "21.5b1"
 ```