Skip to content

Commit 86ebaf6

Browse files
authored
doc: add section in developement.md for code generation with librarian (#13404)
Updates DEVELOPMENT.md to include a new section on code generation using Librarian, providing links to various guides and documentation. For googleapis/librarian#5497
1 parent bc90e19 commit 86ebaf6

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

DEVELOPMENT.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Monorepo Scoped Development Guide
22

3-
This document outlines development workflows and build strategies when working with specific client libraries or modules in the `google-cloud-java` monorepo.
3+
This document outlines development workflows, build strategies, and code generation processes when working with or managing client libraries in the `google-cloud-java` monorepo.
44

55
---
66

@@ -51,3 +51,20 @@ mvn compile
5151
```
5252

5353
Your IDE such as Intellij should also be able to import all the upstream dependencies at this moment. You can perform the same operations as you would in a normal project such as running unit tests, debugging and so on.
54+
55+
---
56+
57+
## 3. Code Generation (Librarian)
58+
59+
This repository uses **[Librarian](https://github.com/googleapis/librarian)** to generate code from API specifications.
60+
61+
The configuration for Librarian in this repository is defined in the [librarian.yaml](librarian.yaml) file at the root.
62+
63+
### Documentation & Guides
64+
65+
For more information on how to use Librarian, configure generation, or troubleshoot issues, refer to the following guides:
66+
67+
* **[Librarian GitHub Repository](https://github.com/googleapis/librarian)**: The main repository for the Librarian tool.
68+
* **[Librarian Command Reference](https://pkg.go.dev/github.com/googleapis/librarian/cmd/librarian)**: Detailed documentation of `librarian` CLI commands.
69+
* **[Librarian Configuration Schema](https://github.com/googleapis/librarian/blob/main/doc/config-schema.md)**: Guide to the structure and options available in `librarian.yaml`.
70+
* **[go/g3doc-sdk-librarian](https://go/g3doc-sdk-librarian)** (Internal): Internal documentation for code generation schedules and local development workflows.

0 commit comments

Comments
 (0)