Skip to main content

A CLI tool to automate fetching, cleaning, summarizing, and posting release notes from Azure DevOps.

Project description

Release Note Automator

Python Version License Build

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

release_note_automator-0.1.4.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

release_note_automator-0.1.4-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

Details for the file release_note_automator-0.1.4.tar.gz.

File metadata

  • Download URL: release_note_automator-0.1.4.tar.gz
  • Upload date:
  • Size: 11.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for release_note_automator-0.1.4.tar.gz
Algorithm Hash digest
SHA256 d7bad471bab127a6751f12191da1ecbe884e46d554c31e39cb070801fc531201
MD5 16204c5fd98615d0b65cda2aae938f2b
BLAKE2b-256 56ee1a7af5233f4eff4635e19078de62cba2c9923414030cf617cf938c61f6e1

See more details on using hashes here.

File details

Details for the file release_note_automator-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for release_note_automator-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 a8d67baecde495f35982c333e8df93ed382331e3afd789ca9a60b30ae9f00db8
MD5 d5c5063eed8006bc40c32911cf6c3636
BLAKE2b-256 da9214d58440a4f6cac721fd53d887a9e9518ea52ae25a15504f4d32a9ee7cac

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page