doc(release): update release docs with BCR instructions - #16329
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the release documentation in release/README.md by removing outdated steps, updating GitHub release instructions, and adding a detailed guide for updating the google_cloud_cpp Bazel Central Registry (BCR) module. The review feedback identifies several issues in the new BCR instructions, including incorrect version variable prefixes, a typo, a hardcoded version in a heading, and a missing variable assignment that would break the checksum replacement command.
| OLD_VERSION=... # e.g. v2.12.0 | ||
| VERSION=... # e.g. v2.13.0 |
There was a problem hiding this comment.
In the Bazel Central Registry, module versions do not include the v prefix (e.g., they are 2.13.0 instead of v2.13.0). If the v prefix is included in the VERSION variable, the directory creation (modules/google_cloud_cpp/${VERSION}) and other commands will use the incorrect path. Please define these variables without the v prefix.
| OLD_VERSION=... # e.g. v2.12.0 | |
| VERSION=... # e.g. v2.13.0 | |
| OLD_VERSION=... # e.g. 2.12.0 | |
| VERSION=... # e.g. 2.13.0 |
| cp -r modules/google_cloud_cpp/${OLD_VERSION}/* modules/google_cloud_cpp/${VERSION} | ||
| ``` | ||
|
|
||
| #### Overwrite the the MODULE.bazel file with MODULE.bazel file from the release |
There was a problem hiding this comment.
There is a duplicate word "the" in this heading.
| #### Overwrite the the MODULE.bazel file with MODULE.bazel file from the release | |
| #### Overwrite the MODULE.bazel file with MODULE.bazel file from the release |
| ] | ||
| ``` | ||
|
|
||
| #### Update the modules/google_cloud_cpp/3.8.0/source.json |
There was a problem hiding this comment.
To make the instructions consistent and generic, use ${VERSION} in the heading instead of the hardcoded version 3.8.0.
| #### Update the modules/google_cloud_cpp/3.8.0/source.json | |
| #### Update the modules/google_cloud_cpp/${VERSION}/source.json |
| command: | ||
|
|
||
| ```shell | ||
| curl -fSsL https://github.com/googleapis/google-cloud-cpp/archive/v${VERSION}.tar.gz | sha256sum | awk '{print $1}' | xxd -r -p | base64 |
There was a problem hiding this comment.
The command computes the base64 SHA256 checksum but does not assign it to the SHA256 environment variable. As a result, the subsequent sed command will replace the integrity field with an empty hash. Assign the output of the command to the SHA256 variable.
| curl -fSsL https://github.com/googleapis/google-cloud-cpp/archive/v${VERSION}.tar.gz | sha256sum | awk '{print $1}' | xxd -r -p | base64 | |
| SHA256=$(curl -fSsL https://github.com/googleapis/google-cloud-cpp/archive/v${VERSION}.tar.gz | sha256sum | awk '{print $1}' | xxd -r -p | base64) |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #16329 +/- ##
=======================================
Coverage 92.23% 92.23%
=======================================
Files 2227 2227
Lines 209169 209169
=======================================
+ Hits 192929 192932 +3
+ Misses 16240 16237 -3 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
colinmoy
left a comment
colinmoy
left a comment
There was a problem hiding this comment.
See gemini bot's suggestions
2 participants
No description provided.