google-gemini
AI-powered GitHub Action
Description of the feature request:
This is a proposal to add a new cookbook example: an AI-powered GitHub Action that converts plain text into well-structured Markdown documentation.
What problem are you trying to solve with this feature?
Many developers need to create clear documentation (like README.md files) but find manual formatting tedious. This tool automates the process by leveraging the Gemini API to intelligently structure the text, saving time and ensuring consistency.
The workflow is triggered by a push to a source text file (e.g., source.txt). It then:
- Reads the content of the text file.
- Calls the Gemini API to generate a Markdown version of the text.
- Automatically commits the new Markdown content to a destination file (e.g.,
README.md).
This makes the documentation process a simple "write and push" action.
The complete and working code for this example is available in my public repository:
https://github.com/ROHANDWIVEDI2005/Convert_to_md
Any other information you'd like to share?
No response
Thanks for the PR @ROHANDWIVEDI2005, but I have to say I'm not sure of the value added for the cookbook. If it's just a text to markdown converter, maybe just a notebook example would be enough, no?
Thanks for your feedback @Giom-V but the aim for this example was to showcase how the gemini-api capabilities can be used in a real world CI/CD environment A github action which can automate a task ,but i guess I could add a companion notebook showcasing a more detailed step-by-step walk-through of the example.
@Giom-V If an end-to-end working example is not suitable for the cookbook would it be better to create a notebook about the same markdown-to-text converter but implementing it with the PyGithub library instead of the GitHub-actions approach It will be similar to #887 and still retaining the purpose of task automation.
@markmcd is this something that would be usefull to the gemini-cli repo