Skip to content

chore: add release-please tags to generated docs - #2525

Merged
hessjcg merged 1 commit into
mainfrom
fix-release-please-docs
Aug 13, 2026
Merged

chore: add release-please tags to generated docs#2525
hessjcg merged 1 commit into
mainfrom
fix-release-please-docs

Conversation

@hessjcg

@hessjcg hessjcg commented Dec 9, 2025

Copy link
Copy Markdown
Collaborator

Adds a step to the doc generation to include release-please tags. This allows release-please to automatically update the version in the generated documentation.

@hessjcg
hessjcg requested a review from a team as a code owner December 9, 2025 20:59
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+/`)

Check failure

Code scanning / CodeQL

Incomplete regular expression for hostnames High

This regular expression has an unescaped dot before 'googleapis.com', so it might match more hosts than expected when the regular expression is used.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

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+/`)

Check failure

Code scanning / CodeQL

Missing regular expression anchor High

When this is used as a regular expression on a URL, it may match anywhere, and arbitrary hosts may come before or after it.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I used \b word break instead of ^\s* to allow more flexibility.

@hessjcg
hessjcg force-pushed the fix-release-please-docs branch 2 times, most recently from f79e8cd to e179a1a Compare August 13, 2026 17:21
Comment thread cmd/gendocs/gen_cloud-sql-proxy_docs.go Fixed
@hessjcg
hessjcg force-pushed the fix-release-please-docs branch 3 times, most recently from 53e18db to 54ddec5 Compare August 13, 2026 17:34
Comment thread cmd/gendocs/gen_cloud-sql-proxy_docs.go Fixed
@hessjcg
hessjcg force-pushed the fix-release-please-docs branch from 54ddec5 to 7ade152 Compare August 13, 2026 17:42
Comment thread cmd/gendocs/gen_cloud-sql-proxy_docs.go Fixed
Adds a step to the doc generation to include release-please tags. This allows release-please to automatically update the version in the generated documentation.
@hessjcg
hessjcg force-pushed the fix-release-please-docs branch from 7ade152 to b18daee Compare August 13, 2026 17:46
@hessjcg
hessjcg merged commit 495df6c into main Aug 13, 2026
21 checks passed
@hessjcg
hessjcg deleted the fix-release-please-docs branch August 13, 2026 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants