UNPKG

@roadiehq/backstage-entity-validator-test-ci

Version:

Backstage entity validator

github.com/RoadieHQ/backstage-entity-validator

RoadieHQ/backstage-entity-validator

129 lines (89 loc) • 2.57 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# Backstage entity validator This package can be used as a GitHub action or a standalone node.js module ## GitHub action ### Inputs #### `path` **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 seperated by comma `users.yaml,orgs/company.yaml`. #### `verbose` **Optional** Specify whether the output should be verbose. Default `true`. ### Outputs None. Prints out the validated YAML on success. Prints out errors on invalid YAML ### Example usage ``` - uses: RoadieHQ/backstage-entity-validator@v0.3.2 with: path: 'catalog-info-1.yaml' ``` ``` - uses: RoadieHQ/backstage-entity-validator@v0.3.2 with: path: 'catalog-info-1.yaml,catalog-info-2.yaml,catalog-info-3.yaml' ``` ``` - uses: RoadieHQ/backstage-entity-validator@v0.3.2 with: path: 'catalog-info-*.yaml,services/**/*/catalog-info.yaml' ``` ## CircleCI Orb ### Inputs #### `path` **Optional** Path to the catalog-info.yaml file to validate. Defaults to `catalog-info.yaml` at the root of the repository. ### Outputs None. Prints out the validated YAML on success. Prints out errors on invalid YAML ### Example config ``` description: > Sample catalog-info.yaml validation usage: version: 2.1 orbs: entity-validator: "roadiehq/backstage-entity-validator@0.3.0" workflows: use-entity-validator: jobs: - entity-validator/validate: path: catalog-info.yaml ``` ## Using the CLI ### Usage ``` Usage: validate-entity [OPTION] [FILE] Validates Backstage entity definition files. Files may be specified as arguments or via STDIN, one per line. OPTION: -h display help -q minimal output while validating entities -i validate files provided over standard input ``` Examples: ``` # in a shell # validate all entities contained in the "catalog" and subfolders validate-entity catalog/**/*.yaml # list of files produced by a script to validate find-relevant-yaml-files.sh | validate-entity -i ``` ### Installing and running #### As a global tool ``` # install npm install --global @roadiehq/backstage-entity-validator # run validate-entity file1.yaml file2.yaml ``` #### In an existing node project ``` # install npm install --save-dev @roadiehq/backstage-entity-validator # run npx validate-entity file1.yaml file2.yaml ``` #### When working on this tool ``` # install npm install # run npm run validate file1.yaml file2.yaml # or bin/bev file1.yaml file2.yaml ```