diff --git a/cmd/gendocs/gen_cloud-sql-proxy_docs.go b/cmd/gendocs/gen_cloud-sql-proxy_docs.go index 1829d54ea..b028559c9 100644 --- a/cmd/gendocs/gen_cloud-sql-proxy_docs.go +++ b/cmd/gendocs/gen_cloud-sql-proxy_docs.go @@ -15,9 +15,12 @@ package main import ( + "bufio" + "bytes" "fmt" "os" "path/filepath" + "regexp" "github.com/GoogleCloudPlatform/cloud-sql-proxy/v2/cmd" "github.com/spf13/cobra/doc" @@ -48,4 +51,40 @@ func main() { cloudSQLProxy.Execute() cloudSQLProxy.DisableAutoGenTag = true doc.GenMarkdownTree(cloudSQLProxy.Command, outDir) + + // Edit the Markdown file to add release-please tags around the lines that contain + // the version number: + // + // + // https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.20.0/third_party/licenses.tar.gz + // + + f := filepath.Join(outDir, "cloud-sql-proxy.md") + b, err := os.ReadFile(f) + if err != nil { + fmt.Fprintf(os.Stderr, "failed to read file: %v\n", err) + os.Exit(1) + } + + var out bytes.Buffer + sc := bufio.NewScanner(bytes.NewReader(b)) + // Example: https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.20.0/third_party/licenses.tar.gz + re := regexp.MustCompile(`https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v\d+\.\d+\.\d+/`) + for sc.Scan() { + line := sc.Bytes() + if re.Match(line) { + out.WriteString("\n") + out.Write(line) + out.WriteString("\n") + out.WriteString("\n") + } else { + out.Write(line) + out.WriteString("\n") + } + } + + if err := os.WriteFile(f, out.Bytes(), 0644); err != nil { + fmt.Fprintf(os.Stderr, "failed to write file: %v\n", err) + os.Exit(1) + } } diff --git a/docs/cmd/cloud-sql-proxy.md b/docs/cmd/cloud-sql-proxy.md index 9ef687f1f..a0357de68 100644 --- a/docs/cmd/cloud-sql-proxy.md +++ b/docs/cmd/cloud-sql-proxy.md @@ -218,7 +218,9 @@ Third Party Licenses To view all licenses for third party dependencies used within this distribution please see: + https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.20.0/third_party/licenses.tar.gz + ```