Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Do not process hidden function versions. #252

Merged
merged 1 commit into from
Apr 28, 2021
+23 −12
Merged

Do not process hidden function versions. #252

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 23 additions & 12 deletions scripts/generate_catalog/generate_catalog.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,7 @@ type metadata struct {
Tags []string
SourceUrl string `yaml:"sourceURL"`
ExamplePackageUrls []string `yaml:"examplePackageURLs"`
Hidden bool
}

var (
Expand Down Expand Up @@ -135,6 +136,17 @@ func getFunctions(branches []string, source string, dest string) []function {
os.Exit(1)
}

// Functions with the hidden field enabled should not be processed.
metadataPath := strings.TrimSpace(fmt.Sprintf("%v:%v", b, filepath.Join(relativeFuncPath, "metadata.yaml")))
md, err := getMetadata(metadataPath)
if err != nil {
fmt.Fprintf(os.Stderr, "%v\n", err)
os.Exit(1)
}
if md.Hidden {
continue
}

err = copyExamples(b, funcName, funcDest, versionDest)
if err != nil {
fmt.Fprintf(os.Stderr, "%v\n", err)
Expand All @@ -152,13 +164,8 @@ func getFunctions(branches []string, source string, dest string) []function {
if f.VersionToExamples == nil {
f.VersionToExamples = make(map[string]map[string]example)
}
metadataPath := strings.TrimSpace(fmt.Sprintf("%v:%v", b, filepath.Join(relativeFuncPath, "metadata.yaml")))
f, err = parseMetadata(f, metadataPath, minorVersion, versionDest)
if err != nil {
fmt.Fprintf(os.Stderr, "%v\n", err)
os.Exit(1)
}
functions[funcName] = f

functions[funcName] = parseMetadata(f, md, minorVersion, versionDest)
}

flattenedFunctions := make([]function, 0)
Expand Down Expand Up @@ -227,18 +234,22 @@ func copyReadme(b string, funcName string, relativeFuncPath string, versionDest
return nil
}

func parseMetadata(f function, metadataPath string, version string, versionDest string) (function, error) {
func getMetadata(metadataPath string) (metadata, error) {
var buf bytes.Buffer
var md metadata
// Get the content of metadata.yaml from the appropriate release branch.
cmd := exec.Command("git", "cat-file", "blob", metadataPath)
cmd.Stdout = &buf
err := cmd.Run()
if err != nil {
return f, err
return md, err
}

var md metadata
yaml.Unmarshal(buf.Bytes(), &md)
return md, nil
}

func parseMetadata(f function, md metadata, version string, versionDest string) function {

// Add examples to version map.
if f.VersionToExamples[version] == nil {
Expand All @@ -257,7 +268,7 @@ func parseMetadata(f function, metadataPath string, version string, versionDest
}
f.VersionToExamples[version] = e
if semver.Compare(f.LatestVersion, version) == 1 {
return f, nil
return f
}

// If this is the latest version,
Expand All @@ -268,7 +279,7 @@ func parseMetadata(f function, metadataPath string, version string, versionDest
sort.Sort(sort.StringSlice(md.Tags))
f.Tags = strings.Join(md.Tags, ",")

return f, nil
return f
}

func getRelativeFunctionPath(source string, funcName string) (string, error) {
Expand Down