exclude_file input option

[GrantBirki]

exclude_file input option

This pull request introduces a new input option for the Action:

• exclude_file - The full path to a file in the repository where this Action is running that contains a list of '.gitignore'-style patterns to exclude files from validation (e.g. ./exclude.txt)

Excluding Files

Now, there are three main ways you can go about excluding files from being validated with this Action:

• json_exclude_regex - A regex string that will be used to exclude JSON files from being validated
• yaml_exclude_regex - A regex string that will be used to exclude YAML files from being validated
• exclude_file - best way to exclude files - A file that contains a list of files to exclude from being validated in gitignore format

It should be strongly noted that both json_exclude_regex and yaml_exclude_regex options get unwieldy very quickly and are not recommended. The exclude_file option is the best way to exclude files from being validated. Especially if you have a large repository with many files.
Example of an exclude_file's contents:

# exclude all files in the test/ directory
test/

# exclude a yaml file at an exact path
src/cool-path/example.yaml

# exclude all json files with some glob matching
*.test.json

If the file path to your exclude_file is exclude.txt, you would set the exclude_file input to exclude.txt like so:

# checkout the repository
- uses: actions/checkout@v3.5.0

- name: json-yaml-validate
  uses: GrantBirki/json-yaml-validate@vX.X.X # replace with the latest version
  with:
    exclude_file: exclude.txt # gitignore style file that contains a list of files to exclude