Skip to content

Commit a786fe7

Browse files
doc: update README to reflect new exclude mechanism
Signed-off-by: Ingo Müller <[email protected]>
1 parent 9234944 commit a786fe7

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -30,4 +30,9 @@ jobs:
3030

3131
You can pass any other [YAPF parameter](https://github.com/google/yapf#usage) using the `args` setting, e.g. for setting a different code style (default is PEP8), but you can also remove the `with` section entirely if you wish.
3232

33-
If you want to exclude a certain directory, you can use the args field like this: `args: --verbose --exclude '**/tests/**'`. Thank you [@pksol](https://github.com/pksol) for the [example](https://github.com/AlexanderMelde/yapf-action/issues/1).
33+
If you want to exclude a certain file or directory, you can either use the `--exclude` parameter or a `.yapfignore` file.
34+
35+
### Migration Notice
36+
Earlier versions of this action did not set the working directory before executing `yapf`.
37+
38+
If you used the `--exclude '**/tests/**'` workaround, you might need to simplify this to `--exclude 'tests/**'` now.

0 commit comments

Comments
 (0)