Skip to content

Commit 66511af

Browse files
authored
docs: update how-to guide to generate libraries (#11851)
1 parent 6f46b3d commit 66511af

1 file changed

Lines changed: 19 additions & 11 deletions

File tree

doc/contributor/howto-guide-adding-generated-libraries.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -184,6 +184,17 @@ Otherwise, if you are generating an experimental library, add it to
184184
`GOOGLE_CLOUD_CPP_EXPERIMENTAL_LIBRARIES` and note in a comment when the library
185185
was generated.
186186

187+
## Add the API baseline
188+
189+
For new GA libraries you need to create the API baseline. You can leave this
190+
running while you work on tweaks to the quickstart and documentation.
191+
192+
```shell
193+
env GOOGLE_CLOUD_CPP_CHECK_API=${library} ci/cloudbuild/build.sh -t check-api-pr
194+
git add ci/abi-dumps
195+
git commit -m"Add API baseline" ci/abi-dumps/
196+
```
197+
187198
## Update the quickstart
188199

189200
The generated quickstart will need some editing. Use a simple operation, maybe
@@ -212,6 +223,13 @@ were written by a robot:
212223
The Cloud documentation links (`cloud.google.com/*/docs/*`) in these files are
213224
not always valid. Find the correct urls and update the links.
214225

226+
## Review the metadata file
227+
228+
Newer services provide all the data needed to generate this file correctly,
229+
but with older services we need to edit a few places:
230+
231+
- `google/cloud/${library}/**/.repo-metadata.json`
232+
215233
## Edit the top-level CHANGELOG file
216234

217235
Announce the new library in the CHANGELOG for the next release.
@@ -222,15 +240,6 @@ Announce the new library in the CHANGELOG for the next release.
222240
ci/cloudbuild/build.sh -t checkers-pr
223241
```
224242

225-
## Add the API baseline
226-
227-
For new GA libraries you need to create the API baseline.
228-
229-
```
230-
env GOOGLE_CLOUD_CPP_CHECK_API=${library} ci/cloudbuild/build.sh -t check-api-pr
231-
git commit -m"Add API baseline" ci/abi-dumps/
232-
```
233-
234243
## Verify everything compiles
235244

236245
```shell
@@ -266,8 +275,7 @@ index c4ce00489..1858b48dc 100755
266275
## Commit these changes
267276

268277
```shell
269-
git commit -m"Manually update READMEs, quickstart, and top-level stuff" \
270-
"google/cloud/${library}" CHANGELOG.md ci cmake README.md
278+
git commit -m"Manually update READMEs, quickstart, and top-level stuff" .
271279
```
272280

273281
[#10237]: https://github.com/googleapis/google-cloud-cpp/issues/10237

0 commit comments

Comments
 (0)