{"id":17473666,"url":"https://github.com/skippypeanutbutter/yaml_bot","last_synced_at":"2025-04-22T10:38:21.890Z","repository":{"id":56898918,"uuid":"68343902","full_name":"skippyPeanutButter/yaml_bot","owner":"skippyPeanutButter","description":"Validate the content of a yaml file according to a set of rules","archived":false,"fork":false,"pushed_at":"2018-04-01T21:58:12.000Z","size":96,"stargazers_count":3,"open_issues_count":8,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-09-17T02:22:30.512Z","etag":null,"topics":["rspec","ruby","ruby-gem","yaml"],"latest_commit_sha":null,"homepage":"","language":"Ruby","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/skippyPeanutButter.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-09-16T01:15:29.000Z","updated_at":"2018-10-19T01:45:09.000Z","dependencies_parsed_at":"2022-08-20T17:40:27.998Z","dependency_job_id":null,"html_url":"https://github.com/skippyPeanutButter/yaml_bot","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skippyPeanutButter%2Fyaml_bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skippyPeanutButter%2Fyaml_bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skippyPeanutButter%2Fyaml_bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/skippyPeanutButter%2Fyaml_bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/skippyPeanutButter","download_url":"https://codeload.github.com/skippyPeanutButter/yaml_bot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":220382844,"owners_count":16638854,"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":["rspec","ruby","ruby-gem","yaml"],"created_at":"2024-10-18T18:06:11.010Z","updated_at":"2024-10-18T18:06:12.427Z","avatar_url":"https://github.com/skippyPeanutButter.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.org/skippyPeanutButter/yaml_bot.svg?branch=master)](https://travis-ci.org/skippyPeanutButter/yaml_bot)\n[![Code Climate](https://codeclimate.com/github/skippyPeanutButter/yaml_bot/badges/gpa.svg)](https://codeclimate.com/github/skippyPeanutButter/yaml_bot)\n[![Test Coverage](https://codeclimate.com/github/skippyPeanutButter/yaml_bot/badges/coverage.svg)](https://codeclimate.com/github/skippyPeanutButter/yaml_bot/coverage)\n\n# YamlBot\n\nYamlBot is not a Yaml linter, it is a Yaml format validator.\n\n\n### Why\n\nMistakes can often be made when working with yaml-based configuration. Systems\nsuch as travis-ci, rubocop, and other tools that utilize yaml files to govern\nhow they work often present users with a multitude of keys and options that can\ntake on many possible values. `yamlbot` allows users to feed it a set of rules\nthat a yaml-based system follows and then validate any yaml file against those\nrules.\n\nIf a tool works off of a yaml-based configuration then a rules file can be\ncrafted for validating the configuration is correct. Create a rules file, share\nit with others, and have them use `yamlbot` to validate their configuration\nagainst the specified rules.\n\nSee the [RULES FILE](RULES_DEFINITION.md) specification for details on creating\na `.yamlbot.yml` rules file.\n\n### Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'yaml_bot'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install yaml_bot\n\n### Usage\n\nCreate a `.yamlbot.yml` file with a set of rules that you want to validate yaml\nfiles against [yamlbot file specification](RULES_DEFINITION.md).\n\nUsage assuming the existence `.yamlbot.yml` in the current directory:\n\n```bash\nyamlbot -f yaml_file_to_validate\n```\n\nUsage passing the path to a rules file\n(doesn't have to be named `.yamlbot.yml`):\n\n```bash\nyamlbot -f yaml_file_to_validate [-r path_to_rules_file]\n```\n\n```bash\nUsage: yamlbot -f yaml_file_to_validate [-r path_to_rules_file]\n        -r, --rule-file rules           The rules you will be evaluating your yaml against\n        -f, --file file                 The file to validate against\n        -h, --help                      help\n```\n\n### Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. Then, run\n`rake spec` to run the tests. You can also run `bin/console` for an interactive\nprompt that will allow you to experiment.\n\nTo install this gem onto your local machine, run `bundle exec rake install`. To\nrelease a new version, update the version number in `version.rb`, and then run\n`bundle exec rake release`, which will create a git tag for the version, push\ngit commits and tags, and push the `.gem` file to\n[rubygems.org](https://rubygems.org).\n\n### Contributing\n\nBug reports and pull requests are welcome on GitHub at\nhttps://github.com/skippyPeanutButter/yaml_bot. This project is intended to be a\nsafe, welcoming space for collaboration, and contributors are expected to adhere\nto the [Contributor Covenant](http://contributor-covenant.org) code of conduct.\n\n\n### License\n\nThe gem is available as open source under the terms of the [MIT\nLicense](http://opensource.org/licenses/MIT).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskippypeanutbutter%2Fyaml_bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fskippypeanutbutter%2Fyaml_bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fskippypeanutbutter%2Fyaml_bot/lists"}