{"id":13573058,"url":"https://github.com/RoadieHQ/backstage-entity-validator","last_synced_at":"2025-04-04T11:31:15.083Z","repository":{"id":41770988,"uuid":"366663725","full_name":"RoadieHQ/backstage-entity-validator","owner":"RoadieHQ","description":"Validate properties and well known annotations in your Backstage catalog-info.yaml files.","archived":false,"fork":false,"pushed_at":"2024-11-19T04:24:52.000Z","size":3765,"stargazers_count":74,"open_issues_count":20,"forks_count":13,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-03-28T04:56:33.435Z","etag":null,"topics":["backstage"],"latest_commit_sha":null,"homepage":"https://roadie.io","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RoadieHQ.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2021-05-12T09:33:59.000Z","updated_at":"2025-03-12T15:54:55.000Z","dependencies_parsed_at":"2024-01-17T10:05:05.886Z","dependency_job_id":"b2d472d6-a372-456d-9b42-6980d9818c66","html_url":"https://github.com/RoadieHQ/backstage-entity-validator","commit_stats":{"total_commits":40,"total_committers":12,"mean_commits":"3.3333333333333335","dds":0.75,"last_synced_commit":"939eb675c481f3e697cc7fe74cce63a09a4e230b"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RoadieHQ%2Fbackstage-entity-validator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RoadieHQ%2Fbackstage-entity-validator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RoadieHQ%2Fbackstage-entity-validator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RoadieHQ%2Fbackstage-entity-validator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RoadieHQ","download_url":"https://codeload.github.com/RoadieHQ/backstage-entity-validator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247170183,"owners_count":20895427,"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":["backstage"],"created_at":"2024-08-01T15:00:28.477Z","updated_at":"2025-04-04T11:31:10.074Z","avatar_url":"https://github.com/RoadieHQ.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# Backstage entity validator\n\nThis package can be used as a GitHub action or a standalone node.js module\n\n## GitHub action\n\n### Inputs\n\n#### `path`\n\n**Optional** Path to the catalog-info.yaml file to validate. Defaults to `catalog-info.yaml` at the root of the repository. It also can be a glob like `services/*/catalog-info.yaml` or a list of files separated by comma `users.yaml,orgs/company.yaml`.\n\n#### `verbose`\n\n**Optional** Specify whether the output should be verbose. Default `true`.\n\n### `validationSchemaFileLocation`\n**Optional** Specify the location of the validation schema file.\n\n### Outputs\n\nNone. Prints out the validated YAML on success. Prints out errors on invalid YAML\n\n### Example usage\n```\n- uses:  RoadieHQ/backstage-entity-validator@v0.3.11\n  with:\n    path: 'catalog-info-1.yaml'\n```\n\n```\n- uses:  RoadieHQ/backstage-entity-validator@v0.3.11\n  with:\n    path: 'catalog-info-1.yaml,catalog-info-2.yaml,catalog-info-3.yaml'\n```\n\n```\n- uses:  RoadieHQ/backstage-entity-validator@v0.3.11\n  with:\n    path: 'catalog-info-*.yaml,services/**/*/catalog-info.yaml'\n```\n\n```\n- uses:  RoadieHQ/backstage-entity-validator@v0.3.2\n  with:\n    path: 'catalog-info-*.yaml,services/**/*/catalog-info.yaml'\n    validationSchemaFileLocation: 'custom-validation-schema.json'\n```\n\n## CircleCI Orb\n\n### Inputs\n\n#### `path`\n\n**Optional** Path to the catalog-info.yaml file to validate. Defaults to `catalog-info.yaml` at the root of the repository.\n\n### Outputs\n\nNone. Prints out the validated YAML on success. Prints out errors on invalid YAML\n\n### Example config\n```\ndescription: \u003e\n  Sample catalog-info.yaml validation\nusage:\n  version: 2.1\n  orbs:\n    entity-validator: \"roadiehq/backstage-entity-validator@0.3.11\"\n  workflows:\n    use-entity-validator:\n      jobs:\n        - entity-validator/validate:\n            path: catalog-info.yaml\n```\n\n\n## Using the CLI\n\n### Usage\n\n```\nUsage: validate-entity [OPTION] [FILE]\n\nValidates Backstage entity definition files.  Files may be specified as\narguments or via STDIN, one per line.\n\nOPTION:\n-h  display help\n-q  minimal output while validating entities\n-i  validate files provided over standard input\n-l  location of custom validation schema file\n```\n\nExamples:\n\n```\n# in a shell\n\n# validate all entities contained in the \"catalog\" and subfolders\nvalidate-entity catalog/**/*.yaml\n\n# list of files produced by a script to validate\nfind-relevant-yaml-files.sh | validate-entity -i \n```\n\n### Installing and running\n\n#### As a global tool\n\n```\n# install\nnpm install --global @roadiehq/backstage-entity-validator\n\n# run\nvalidate-entity file1.yaml file2.yaml\n```\n#### In an existing node project\n\n```\n# install\nnpm install --save-dev @roadiehq/backstage-entity-validator\n\n# run\nnpx validate-entity file1.yaml file2.yaml\n```\n\n#### When working on this tool\n\n```\n# install\nnpm install\n\n# run\nnpm run validate file1.yaml file2.yaml\n\n# or\nbin/bev file1.yaml file2.yaml\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRoadieHQ%2Fbackstage-entity-validator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FRoadieHQ%2Fbackstage-entity-validator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRoadieHQ%2Fbackstage-entity-validator/lists"}