v2.2.1

What's Changed

• Bug Fix: Report all errors, not just one by @GrantBirki in #33

Thanks to @JohnnyJayJay for the bug report that got resolved in this release! 🚀

Full Changelog: v2.2.0...v2.2.1

v2.2.0

v2.2.0

This release does the following:

• Bug fixes
• Performance improvements via fdir usage in #27
• A new input option (files) via #31

For more details, see the section below and check out the PRs that landed 🚀

What's Changed

• Replace glob with fdir by @thecodrr in #27
• fdir modifications by @GrantBirki in #28
• Update Docs by @GrantBirki in #29
• Add support for validating specified files by @thecodrr in #31
• JSON as YAML - Bug Fix by @GrantBirki in #26 with help from @JohnnyJayJay

New Contributors

• @thecodrr made their first contribution in #27

Full Changelog: v2.1.0...v2.2.0

v2.1.0

v2.1.0

What's Changed

• Add ajv formats by @GrantBirki in #22 with help from @thecodrr 🎉
• npm update by @GrantBirki in #23
• input improvements by @GrantBirki in #24
• debug improvements by @GrantBirki in #25

Full Changelog: v2.0.0...v2.1.0

v2.0.0

v2.0.0

⚠️ Breaking Changes ⚠️

This release introduces potential breaking changes (#17) through the new use_dot_match option:

• use_dot_match - Tells the Action whether to search paths that are "hidden" (begin with a . like .github). This option defaults to "true" and will search all paths matching "dot path criteria" unless set to "false".

For the majority of users, I do not expect issues to arise from this release. However, if you are not expecting dot (.) directories to be scanned, this Action may now fail for you unless you exclude this setting through use_dot_match: "false".

As always, feel free to open an issue in this repository if you have any questions

What's Changed

• Bump tough-cookie from 4.1.2 to 4.1.3 by @dependabot in #15
• Dot Matching by @GrantBirki in #17
• Node package updates by @GrantBirki in #18

Full Changelog: v1.5.0...v2.0.0

v1.5.0

v1.5.0

This release adds a new input option (yaml_as_json) which allows you to use the more robust json_schema parser against YAML files.

What's Changed

• Allow validating YAML files with a JSON schema by @knightzmc in #13
• Yaml as json docs by @GrantBirki in #14

New Contributors

• @knightzmc made their first contribution in #13

Full Changelog: v1.4.0...v1.5.0

v1.4.0

v1.4.0

This release adds a new feature to the Action which enables it to only validate "git tracked files" by default. It does this by treating your project's .gitignore file as an extra exclude.txt file when running. This release also introduces two new input options to help you control this new behavior:

• use_gitignore - If the .gitignore file in your project should be used to check if a file should be checked by this Action or not
• git_ignore_path - The path to the .gitignore file in your repository to use if use_gitignore is set (which it is by default).

What's Changed

• Only Validate Git Tracked Files by @GrantBirki in #10
• set comment mode to true in acceptance test by @GrantBirki in #11
• npm update by @GrantBirki in #12

Special thanks to @djrmarques in #9 for helping with the idea on this feature

Full Changelog: v1.3.2...v1.4.0

v1.3.2

v1.3.2

This release updates internal dependencies in the Action

What's Changed

• Bump yaml from 2.2.1 to 2.2.2 by @dependabot in #5

New Contributors

• @dependabot made their first contribution in #5

Full Changelog: v1.3.1...v1.3.2

v1.3.1

v1.3.1

This patch release updates dependent node packages of this Action and minor documentation fixes

What's Changed

• General Updates by @GrantBirki in #4

Full Changelog: v1.3.0...v1.3.1

v1.3.0

v1.3.0

NEW - exclude_file input option

This release 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

---

What's Changed

• Yaml schema notes and improvements by @GrantBirki in #1
• exclude_file input option by @GrantBirki in #2
• update all node packages by @GrantBirki in #3

New Contributors

• @GrantBirki made their first contribution in #1

Full Changelog: v1.2.0...v1.3.0

v1.2.0

v1.2.0

Improve schema validation steps by ignoring the schema files themselves

Full Changelog: v1.1.0...v1.2.0