Print out line diff on test failure (#2552)

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

diff --git a/docs/integrations/github_actions.md b/docs/integrations/github_actions.md
index 9e8cf436453c93e82f29636a59c568163d9b6e4b..e866a3cc616429585a8bcad69e9de10d35ebbfdc 100644 (file)
--- a/docs/integrations/github_actions.md
+++ b/docs/integrations/github_actions.md
@@ -3,6 +3,14 @@
 You can use _Black_ within a GitHub Actions workflow without setting your own Python
 environment. Great for enforcing that your code matches the _Black_ code style.
 
 You can use _Black_ within a GitHub Actions workflow without setting your own Python
 environment. Great for enforcing that your code matches the _Black_ code style.
 

+## Compatibility
+
+This action is known to support all GitHub-hosted runner OSes. In addition, only
+published versions of _Black_ are supported (i.e. whatever is available on PyPI).
+
+Finally, this action installs _Black_ with both the `colorama` and `python2` extras so
+the `--color` flag and formatting Python 2 code are supported.
+

 ## Usage
 
 Create a file named `.github/workflows/black.yml` inside your repository with:
 ## Usage
 
 Create a file named `.github/workflows/black.yml` inside your repository with:


@@ -17,19 +25,26 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2

-      - uses: actions/setup-python@v2

       - uses: psf/black@stable
 ```
 
 We recommend the use of the `@stable` tag, but per version tags also exist if you prefer
       - uses: psf/black@stable
 ```
 
 We recommend the use of the `@stable` tag, but per version tags also exist if you prefer

-that.
+that. Note that the action's version you select is independent of the version of _Black_
+the action will use.
+
+The version of _Black_ the action will use can be configured via `version`. The action
+defaults to the latest release available on PyPI. Only versions available from PyPI are
+supported, so no commit SHAs or branch names.
+
+You can also configure the arguments passed to _Black_ via `options` (defaults to
+`'--check --diff'`) and `src` (default is `'.'`)

 
 

-You may use `options` (Default is `'--check --diff'`) and `src` (Default is `'.'`) as
-follows:
+Here's an example configuration:

 
 ```yaml
 - uses: psf/black@stable
   with:
     options: "--check --verbose"
     src: "./src"
 
 ```yaml
 - uses: psf/black@stable
   with:
     options: "--check --verbose"
     src: "./src"

+    version: "21.5b1"

 ```
 ```