Skip to content

Commit a2abeae

Browse files
committed
fix: update script references for CI
1 parent 73f3ea2 commit a2abeae

File tree

3 files changed

+9
-8
lines changed

3 files changed

+9
-8
lines changed

.github/workflows/ci.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,6 @@ jobs:
1717
with:
1818
go-version: "1.23.2"
1919
- name: Validate contributors
20-
run: go build ./scripts/contributors && ./contributors
20+
run: go build ./cmd/readmevalidation && ./readmevalidation
2121
- name: Remove build file artifact
22-
run: rm ./contributors
22+
run: rm ./readmevalidation

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,4 +136,4 @@ dist
136136
.pnp.*
137137

138138
# Script output
139-
/contributors
139+
/readmevalidation

cmd/readmevalidation/main.go

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
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).
67
package main
78

89
import (

0 commit comments

Comments
 (0)