From a2abeaee2f2b2555b4acdb452e027c62ddc34fc2 Mon Sep 17 00:00:00 2001 From: Michael Smith Date: Mon, 14 Apr 2025 17:58:59 +0000 Subject: [PATCH] fix: update script references for CI --- .github/workflows/ci.yaml | 4 ++-- .gitignore | 2 +- cmd/readmevalidation/main.go | 11 ++++++----- 3 files changed, 9 insertions(+), 8 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index c27a1529..af4ae03e 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -17,6 +17,6 @@ jobs: with: go-version: "1.23.2" - name: Validate contributors - run: go build ./scripts/contributors && ./contributors + run: go build ./cmd/readmevalidation && ./readmevalidation - name: Remove build file artifact - run: rm ./contributors + run: rm ./readmevalidation diff --git a/.gitignore b/.gitignore index 5f109fd9..0f945ce6 100644 --- a/.gitignore +++ b/.gitignore @@ -136,4 +136,4 @@ dist .pnp.* # Script output -/contributors +/readmevalidation diff --git a/cmd/readmevalidation/main.go b/cmd/readmevalidation/main.go index 7c6a2bbf..789797ef 100644 --- a/cmd/readmevalidation/main.go +++ b/cmd/readmevalidation/main.go @@ -1,8 +1,9 @@ -// This package is for validating all contributors within the main Registry -// directory. It validates that it has nothing but sub-directories, and that -// each sub-directory has a README.md file. Each of those files must then -// describe a specific contributor. The contents of these files will be parsed -// by the Registry site build step, to be displayed in the Registry site's UI. +// This package is for validating all the README files present in the Registry +// directory. The expectation is that each contributor, module, and template +// will have an associated README containing useful metadata. This metadata must +// be validated for correct structure during CI, because the files themselves +// are parsed and rendered as UI as part of the Registry site build step (the +// Registry site itself lives in a separate repo). package main import (