Skip to content

Commit f6162e2

Browse files
authored
docs: add instructions for manual code generation checks in CI (#13596)
Add documentation following changes in #13568.
1 parent 863c26e commit f6162e2

1 file changed

Lines changed: 21 additions & 1 deletion

File tree

DEVELOPMENT.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,4 +66,24 @@ For more information on how to use Librarian, configure generation, or troublesh
6666

6767
* **[Librarian GitHub Repository](https://github.com/googleapis/librarian)**: The main repository for the Librarian tool.
6868
* **[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`.
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+
71+
### Triggering Code Generation in CI
72+
73+
The repository has automated workflows to manage and verify code generation.
74+
75+
#### Automatically Commit Generated Changes on a PR (Manual Trigger)
76+
77+
> [!NOTE]
78+
> As of June 30, 2026, running this workflow on GitHub Actions takes approximately 90 minutes to complete.
79+
>
80+
If you raise a Pull Request that you expect to introduce changes to generated code (e.g., changes in `gapic-generator-java`), but do not want to run `librarian generate` locally, you can have GitHub Actions automatically regenerate all the client libraries and push the changes back to your branch:
81+
82+
1. Go to the **Actions** tab on the GitHub repository page.
83+
2. Select **Librarian - Generate libraries check / update** from the workflow list on the left.
84+
3. Click the **Run workflow** dropdown menu on the right.
85+
4. Select your **PR branch** from the dropdown and click the **Run workflow** button.
86+
87+
When run manually (via `workflow_dispatch`), the workflow will:
88+
* Run the generation check.
89+
* If any code changes are produced, it will automatically commit the changes (`chore: regenerate libraries`) and push them directly back to your PR branch.

0 commit comments

Comments
 (0)