From 216456a5dfb5e215228b4558cc9e1c9e2842c57a Mon Sep 17 00:00:00 2001 From: Christopher Pfohl Date: Wed, 7 Jun 2023 10:10:55 -0400 Subject: [PATCH] Add Troubleshooting Section to README I bumped into this issue and solved it right as I was writing up the issue. Added it to the README here. I imagine you get a bunch of FAQs or bugs, this could be a great way to help prevent issues. --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 6825eb15..0d4c9346 100644 --- a/README.md +++ b/README.md @@ -519,6 +519,16 @@ jobs: - [test-reporter](https://github.com/dorny/test-reporter) - Displays test results from popular testing frameworks directly in GitHub +## Troubleshooting + +If you are having trouble with this action check for your error message here to see if it can be resolved. + +
+ bad indentation of a mapping entry + + This is most likely caused by invalid YAML, (a missing close quote, or mismatched indentation inside your `filters: |`. The easiest way to debug this is to copy your `filters: |` content into a file with yaml syntax highlighting. +
+ ## License The scripts and documentation in this project are released under the [MIT License](https://github.com/dorny/paths-filter/blob/master/LICENSE)