diff --git a/.github/release-please.yml b/.github/release-please.yml index 3f89510b8..429c00ded 100644 --- a/.github/release-please.yml +++ b/.github/release-please.yml @@ -22,3 +22,5 @@ branches: handleGHRelease: true packageName: cloud-sql-proxy releaseType: simple +extraFiles: + - README.md diff --git a/README.md b/README.md index 712212f5f..78fda5a25 100644 --- a/README.md +++ b/README.md @@ -51,6 +51,7 @@ instance, or by configuring Public IP. Check for the latest version on the [releases page][releases] and use the following instructions for your OS and CPU architecture. +
Linux amd64 @@ -154,6 +155,7 @@ curl https://storage.googleapis.com/cloud-sql-connectors/cloud-sql-proxy/v2.8.0/ ```
+ ### Install from Source @@ -368,6 +370,7 @@ currently supported: - `$VERSION-buster` - `$VERSION-bullseye` + The `$VERSION` is the Proxy version without the leading "v" (e.g., `2.8.0`). @@ -378,6 +381,7 @@ For example, to pull a particular version, use a command like: docker pull gcr.io/cloud-sql-connectors/cloud-sql-proxy:2.8.0 ``` + We recommend pinning to a specific version tag and using automation with a CI pipeline to update regularly.