yamanin/registry
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: make Github field optional

Browse Source
This commit is contained in:
Michael Smith 2025-04-28 19:37:06 +00:00
parent c731a5c64e
commit 7e8d4b7f27
1 changed files with 10 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
cmd/readmevalidation/contributors.go
View File

@ -16,9 +16,8 @@ import (
var validContributorStatuses = []string{"official", "partner", "community"} var validContributorStatuses = []string{"official", "partner", "community"}
type contributorProfileFrontmatter struct { type contributorProfileFrontmatter struct {
DisplayName string `yaml:"display_name"` DisplayName string `yaml:"display_name"`
Bio string `yaml:"bio"` Bio string `yaml:"bio"`
GithubUsername string `yaml:"github"`
// Script assumes that if value is nil, the Registry site build step will // Script assumes that if value is nil, the Registry site build step will
// backfill the value with the user's GitHub avatar URL // backfill the value with the user's GitHub avatar URL
AvatarURL *string `yaml:"avatar"` AvatarURL *string `yaml:"avatar"`
@ -30,22 +29,10 @@ type contributorProfileFrontmatter struct {
type contributorProfile struct { type contributorProfile struct {
frontmatter contributorProfileFrontmatter frontmatter contributorProfileFrontmatter
namespace string
filePath string filePath string
} }
func validateContributorGithubUsername(githubUsername string) error {
if githubUsername == "" {
return errors.New("missing GitHub username")
}
lower := strings.ToLower(githubUsername)
if uriSafe := url.PathEscape(lower); uriSafe != lower {
return fmt.Errorf("gitHub username %q is not a valid URL path segment", githubUsername)
}
return nil
}
func validateContributorDisplayName(displayName string) error { func validateContributorDisplayName(displayName string) error {
if displayName == "" { if displayName == "" {
return fmt.Errorf("missing display_name") return fmt.Errorf("missing display_name")
@ -171,9 +158,6 @@ func validateContributorAvatarURL(avatarURL *string) []error {
func validateContributorYaml(yml contributorProfile) []error { func validateContributorYaml(yml contributorProfile) []error {
allErrs := []error{} allErrs := []error{}
if err := validateContributorGithubUsername(yml.frontmatter.GithubUsername); err != nil {
allErrs = append(allErrs, addFilePathToError(yml.filePath, err))
}
if err := validateContributorDisplayName(yml.frontmatter.DisplayName); err != nil { if err := validateContributorDisplayName(yml.frontmatter.DisplayName); err != nil {
allErrs = append(allErrs, addFilePathToError(yml.filePath, err)) allErrs = append(allErrs, addFilePathToError(yml.filePath, err))
} }
@ -211,11 +195,12 @@ func parseContributorProfile(rm readme) (contributorProfile, error) {
return contributorProfile{ return contributorProfile{
filePath: rm.filePath, filePath: rm.filePath,
frontmatter: yml, frontmatter: yml,
namespace: strings.TrimSuffix(strings.TrimPrefix(rm.filePath, "registry/"), "/README.md"),
}, nil }, nil
} }
func parseContributorFiles(readmeEntries []readme) (map[string]contributorProfile, error) { func parseContributorFiles(readmeEntries []readme) (map[string]contributorProfile, error) {
profilesByUsername := map[string]contributorProfile{} profilesByNamespace := map[string]contributorProfile{}
yamlParsingErrors := []error{} yamlParsingErrors := []error{}
for _, rm := range readmeEntries { for _, rm := range readmeEntries {
p, err := parseContributorProfile(rm) p, err := parseContributorProfile(rm)
@ -224,11 +209,11 @@ func parseContributorFiles(readmeEntries []readme) (map[string]contributorProfil
continue continue
} }
if prev, alreadyExists := profilesByUsername[p.frontmatter.GithubUsername]; alreadyExists { if prev, alreadyExists := profilesByNamespace[p.namespace]; alreadyExists {
yamlParsingErrors = append(yamlParsingErrors, fmt.Errorf("%q: GitHub name %s conflicts with field defined in %q", p.filePath, p.frontmatter.GithubUsername, prev.filePath)) yamlParsingErrors = append(yamlParsingErrors, fmt.Errorf("%q: namespace %q conflicts with namespace from %q", p.filePath, p.namespace, prev.filePath))
continue continue
} }
profilesByUsername[p.frontmatter.GithubUsername] = p profilesByNamespace[p.namespace] = p
} }
if len(yamlParsingErrors) != 0 { if len(yamlParsingErrors) != 0 {
return nil, validationPhaseError{ return nil, validationPhaseError{
@ -238,7 +223,7 @@ func parseContributorFiles(readmeEntries []readme) (map[string]contributorProfil
} }
yamlValidationErrors := []error{} yamlValidationErrors := []error{}
for _, p := range profilesByUsername { for _, p := range profilesByNamespace {
errors := validateContributorYaml(p) errors := validateContributorYaml(p)
if len(errors) > 0 { if len(errors) > 0 {
yamlValidationErrors = append(yamlValidationErrors, errors...) yamlValidationErrors = append(yamlValidationErrors, errors...)
@ -252,7 +237,7 @@ func parseContributorFiles(readmeEntries []readme) (map[string]contributorProfil
} }
} }
return profilesByUsername, nil return profilesByNamespace, nil
} }
func aggregateContributorReadmeFiles() ([]readme, error) { func aggregateContributorReadmeFiles() ([]readme, error) {