A CLI tool to automate fetching, cleaning, summarizing, and posting release notes from Azure DevOps.
Project description
Release Note Automator
Release Note Automator is a command-line tool that fetches, cleans, summarizes, and posts structured release notes from Azure DevOps repositories. Powered by Google Gemini and designed to streamline DevOps communication.
✨ Features
- 🔄 Fetch commits from multiple Azure DevOps repos
- 🧹 Clean noisy commit messages
- 🧠 Summarize using Gemini API
- 🗂️ Format clean markdown release notes
- 📤 Optional Slack integration for posting notes
- ✅ Interactive CLI workflow
- 📦 Packaged for pip and PyPI
📦 Installation
pip install release-note-automator
Or from source:
git clone https://github.com/ankur-helak/release-note-automator.git
cd release-note-automator
pip install .
🚀 Usage
rlauto
The CLI will guide you through:
Entering Azure DevOps org, project, and PAT
Entering Gemini API key
Selecting repositories
Selecting how many days of commit history to consider
Running the release note generation pipeline
Optionally posting notes to Slack
🧠 Requirements
Python 3.8+
Valid Azure DevOps Personal Access Token (PAT)
Google Gemini API key (from Google AI Studio)
Optional Slack Webhook URL
📁 Output
commits/: Raw commit logs
cleaned_commits/: Cleaned and filtered messages
chunks/: Chunked text files for summarization
summaries/: Gemini-based text summaries
release_notes/: Final Markdown release notes
📄 Example
✅ design-studio-backend → SHA: 75a3f88 (starting from: 02 Jun 2025)
✅ design-studio-frontend → SHA: d4bb2d7 (starting from: 02 Jun 2025)
🚀 Running release note pipeline …
✅ Final note saved ➜ release_notes/design-studio-backend_final.md
✅ Final note saved ➜ release_notes/design-studio-frontend_final.md
📣 Do you want to post the release notes to Slack? Yes
✅ Release notes posted to Slack!
🤝 Contributing
Contributions, issues and feature requests are welcome! Feel free to open an issue.
🛡 License
This project is licensed under the terms of the MIT license.
🙋♂️ Author
Ankur Helak – @ankur-helak Email: ankurhelak@gmail.com
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file release_note_automator-0.1.1.tar.gz.
File metadata
- Download URL: release_note_automator-0.1.1.tar.gz
- Upload date:
- Size: 10.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
75ad03be89aa67adc9fbd91ae0f33aec984bcd66898733f0cbb72f4f185b2625
|
|
| MD5 |
154d5ed7f53a187426d6e38943da0c97
|
|
| BLAKE2b-256 |
44b841f7d7cdd2d4d4174fc54251c5f9e64193c43e0b392842f259cd72977db5
|
File details
Details for the file release_note_automator-0.1.1-py3-none-any.whl.
File metadata
- Download URL: release_note_automator-0.1.1-py3-none-any.whl
- Upload date:
- Size: 15.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.13.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b3a8f45234417896c7df5b963b6ea5661f25c3a9dfbaa897d3d80af75b693900
|
|
| MD5 |
91d1278e7d17e95aafce7b265dcc7496
|
|
| BLAKE2b-256 |
3f4375f8d0960b9a3828249bf744a45d1f58ee0e6c3f6a2aa20682d6726d3b0d
|