docs: add instructions for manual code generation checks in CI#13596
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 DEVELOPMENT.md by adding a new section that explains how to trigger automated code generation in CI using GitHub Actions. The review feedback suggests a minor grammatical improvement to replace 'from local' with 'locally' for better readability.
| * Run the generation check. | ||
| * If any code changes are produced, it will automatically commit the changes (`chore: regenerate libraries`) and push them directly back to your PR branch. No newline at end of file |
There was a problem hiding this comment.
nit: a note that a successful run will not produce any output (only errors will be shown if the workflow fails).
This is moreso a thing for some other languages (Go, rust?) but might be different experience for a java dev.
There was a problem hiding this comment.
This is a comment for librarian cli, not this workflow. I'd suggest to file an issue in librarian repo it this bothers you (even slightly).
It is cross language, but there has been discussion on maybe add minimum logging to console.
There was a problem hiding this comment.
It does not bother me and I'm actually ok with no logs (I got used to it when working on librarian for a bit).
This note would be in the java repo meant for other java devs who aren't used to the different behavior (since java outputs quite a bit of logs).
| 1. Go to the **Actions** tab on the GitHub repository page. | ||
| 2. Select **Librarian - Generate libraries check / update** from the workflow list on the left. | ||
| 3. Click the **Run workflow** dropdown menu on the right. | ||
| 4. Select your **PR branch** from the dropdown and click the **Run workflow** button. |
There was a problem hiding this comment.
this will not work in the main branch
There was a problem hiding this comment.
Ack. Developers shouldn't be running this on the main branch anyway, so an explicit note probably isn't necessary.
There was a problem hiding this comment.
admittedly, I ran this on main the first time I used this workflow (it also defaults to main when selecting the dropdown)
2 participants
Add documentation following changes in #13568.