File tree Expand file tree Collapse file tree 3 files changed +9
-8
lines changed Expand file tree Collapse file tree 3 files changed +9
-8
lines changed Original file line number Diff line number Diff line change 17
17
with :
18
18
go-version : " 1.23.2"
19
19
- name : Validate contributors
20
- run : go build ./scripts/contributors && ./contributors
20
+ run : go build ./cmd/readmevalidation && ./readmevalidation
21
21
- name : Remove build file artifact
22
- run : rm ./contributors
22
+ run : rm ./readmevalidation
Original file line number Diff line number Diff line change 136
136
.pnp. *
137
137
138
138
# Script output
139
- /contributors
139
+ /readmevalidation
Original file line number Diff line number Diff line change 1
- // This package is for validating all contributors within the main Registry
2
- // directory. It validates that it has nothing but sub-directories, and that
3
- // each sub-directory has a README.md file. Each of those files must then
4
- // describe a specific contributor. The contents of these files will be parsed
5
- // by the Registry site build step, to be displayed in the Registry site's UI.
1
+ // This package is for validating all the README files present in the Registry
2
+ // directory. The expectation is that each contributor, module, and template
3
+ // will have an associated README containing useful metadata. This metadata must
4
+ // be validated for correct structure during CI, because the files themselves
5
+ // are parsed and rendered as UI as part of the Registry site build step (the
6
+ // Registry site itself lives in a separate repo).
6
7
package main
7
8
8
9
import (
You can’t perform that action at this time.
0 commit comments