Skip to content

Commit bee36cd

Browse files
authored
cleanup(docs): bury automated generate library steps (#13443)
1 parent dea234b commit bee36cd

1 file changed

Lines changed: 14 additions & 14 deletions

File tree

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

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,19 @@ bazel run \
157157
To generate a library that is initially experimental, add an
158158
`--experimental_scaffold` flag.
159159

160+
### Update the root files
161+
162+
Manually edit
163+
[cmake/GoogleCloudCppFeatures.cmake](../../cmake/GoogleCloudCppFeatures.cmake)
164+
to include the new target. If you are generating a GA library, add it to
165+
`GOOGLE_CLOUD_CPP_GA_LIBRARIES`. Otherwise, if you are generating an
166+
experimental library, add it to `GOOGLE_CLOUD_CPP_EXPERIMENTAL_LIBRARIES` and
167+
note in a comment when the library was generated.
168+
169+
Update [libraries.bzl](../../libraries.bzl) to include the new library. While
170+
this can be done by running a cmake-based build, it is fastest to edit the file
171+
manually.
172+
160173
### Fix formatting of existing libraries and the generated code
161174

162175
```shell
@@ -173,7 +186,7 @@ tree google/cloud/$library
173186
### Commit all the generated files
174187

175188
```shell
176-
git add external ci "google/cloud/${library}"
189+
git add external ci "google/cloud/${library}" README.md
177190
git commit -m"Run generators and format their outputs"
178191
```
179192

@@ -205,19 +218,6 @@ knows about one such subdirectory. You may need to manually update the
205218

206219
[#10237] offers one way to automate this step.
207220

208-
### Update the root files
209-
210-
Manually edit
211-
[cmake/GoogleCloudCppFeatures.cmake](../../cmake/GoogleCloudCppFeatures.cmake)
212-
to include the new target. If you are generating a GA library, add it to
213-
`GOOGLE_CLOUD_CPP_GA_LIBRARIES`. Otherwise, if you are generating an
214-
experimental library, add it to `GOOGLE_CLOUD_CPP_EXPERIMENTAL_LIBRARIES` and
215-
note in a comment when the library was generated.
216-
217-
Update [libraries.bzl](../../libraries.bzl) to include the new library. While
218-
this can be done by running a cmake-based build, it is fastest to edit the file
219-
manually.
220-
221221
### Update the quickstart
222222

223223
The generated quickstart will need some editing. Use a simple operation, maybe

0 commit comments

Comments
 (0)