{"id":20312484,"url":"https://github.com/thiagodnf/yaml-schema-checker","last_synced_at":"2025-04-11T16:51:13.325Z","repository":{"id":39931439,"uuid":"493345909","full_name":"thiagodnf/yaml-schema-checker","owner":"thiagodnf","description":"A Github action for validating .yaml files using JSON schemas","archived":false,"fork":false,"pushed_at":"2024-05-01T00:15:05.000Z","size":5996,"stargazers_count":7,"open_issues_count":0,"forks_count":5,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-10T05:51:13.030Z","etag":null,"topics":["checker","codereview","github-actions","jsonschema","validator","yaml"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/yaml-schema-checker","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/thiagodnf.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-05-17T17:16:15.000Z","updated_at":"2025-03-06T21:17:52.000Z","dependencies_parsed_at":"2024-05-01T01:28:01.001Z","dependency_job_id":"abf10802-7917-462e-b7b1-ca99f3d667f4","html_url":"https://github.com/thiagodnf/yaml-schema-checker","commit_stats":{"total_commits":157,"total_committers":4,"mean_commits":39.25,"dds":0.2738853503184714,"last_synced_commit":"51aea53c7b611b385218b34b6a57d8196b8653d2"},"previous_names":[],"tags_count":12,"template":false,"template_full_name":"actions/javascript-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thiagodnf%2Fyaml-schema-checker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thiagodnf%2Fyaml-schema-checker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thiagodnf%2Fyaml-schema-checker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/thiagodnf%2Fyaml-schema-checker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/thiagodnf","download_url":"https://codeload.github.com/thiagodnf/yaml-schema-checker/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248442982,"owners_count":21104311,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["checker","codereview","github-actions","jsonschema","validator","yaml"],"created_at":"2024-11-14T18:06:19.075Z","updated_at":"2025-04-11T16:51:13.289Z","avatar_url":"https://github.com/thiagodnf.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cimg class=\"screenshot\" src=\"https://user-images.githubusercontent.com/98138701/169650464-ac7e1d8a-0050-4368-9331-2b3645cfc994.png\" width=\"276px\"/\u003e\n\nA Github action for validating .yaml files using JSON schemas\n\n[![GitHub Release](https://img.shields.io/github/release/thiagodnf/yaml-schema-checker.svg)](https://github.com/thiagodnf/yaml-schema-checker/releases/latest)\n[![GitHub contributors](https://img.shields.io/github/contributors/thiagodnf/yaml-schema-checker.svg)](https://github.com/thiagodnf/yaml-schema-checker/graphs/contributors)\n[![GitHub stars](https://img.shields.io/github/stars/thiagodnf/yaml-schema-checker.svg)](https://github.com/thiagodnf/yaml-schema-checker)\n[![MIT Licence](https://badges.frapsoft.com/os/mit/mit.svg?v=103)](https://opensource.org/licenses/mit-license.php)\n[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)\n\n## Usage\n\nYou can now consume the action by referencing the available version.\n\n```yaml\nuses: thiagodnf/yaml-schema-checker@v0.0.12\nwith:\n  jsonSchemaFile: schemas/example.schema.json\n  yamlFiles: folder/subfolder/**/*.yml\n```\n\nor you can use combine patterns and files as array:\n\n```yaml\nuses: thiagodnf/yaml-schema-checker@v0.0.12\nwith:\n  jsonSchemaFile: schemas/example.schema.json\n  yamlFiles: |\n    file_1.yml,file_2.yml # two files in the same line\n    file_3.yml\n    folder/subfolder/**/*.yml\n```\n\nThis project uses [glob](https://www.npmjs.com/package/glob) to read files\n\n## Input\n\n### `jsonSchemaFile`\n\n**Required** A JSON schema file following the format used at https://www.schemastore.org\n\n### `yamlFiles`\n\n**Required** A list of files, directories, and wildcard patterns to be validated\n\n\n### `filesSeparator`\n\n**Optional** Separator used to split the files input. Default is `,` (comma).\n\n## Outputs\n\n### `validFiles`\n\nComma separated list of files that passed\n\n### `invalidFiles`\n\nComma separated list of files that failed\n\n## Log\n\nIf you run this GitHub Actions, this is what the log information looks like:\n\n```bash\nRun thiagodnf/yaml-schema-checker@v0.0.12\nJson Schema: schemas/example.schema.json\nYaml Files: folder/subfolder/**/*.yml\nFound 4 file(s). Checking them:\n❌ folder/subfolder/events/fake1.yml\n    - instance.type is not one of enum values: conference,workshop,symposium\n✅ folder/subfolder/events/fake2.yml\n❌ folder/subfolder/events/fake3.yml\n    - instance.id is not of a type(s) string\n    - instance.type is not one of enum values: conference,workshop,symposium\n❌ folder/subfolder/events/fake4.yml\n    - instance.title is not of a type(s) string\nDone. All files checked\n\nError: It was found 3 invalid file(s)\n```\n\n## For Developers\n\nInstall the dependencies\n\n```bash\nnpm install\n```\n\nRun the development enviroment\n\n```bash\nnpm run dev\n```\n\n## Questions or Suggestions\n\nFeel free to access the \u003ca href=\"../../discussions\"\u003ediscussions tab\u003c/a\u003e as you need\n\n## Contribute\n\nContributions to the this project are very welcome! We can't do this alone! Feel free to fork this project, work on it and then make a pull request.\n\n## License\n\nLicensed under the [MIT license](LICENSE).\n\n## Donate\n\nI open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).\n\nHowever, if you get some profit from this or just want to encourage me to continue creating stuff, reach out to me if you want to do it.\n\nThanks!\n\n❤️\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthiagodnf%2Fyaml-schema-checker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthiagodnf%2Fyaml-schema-checker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthiagodnf%2Fyaml-schema-checker/lists"}