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.3.tar.gz (10.9 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.3-py3-none-any.whl (15.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: release_note_automator-0.1.3.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

Hashes for release_note_automator-0.1.3.tar.gz
Algorithm Hash digest
SHA256 d79d2cbb2a4d71a6b7459d8561df029c3fb8551194db9071f3c7ab00f5cc4b52
MD5 cb16bd30a25f1f2837786c274473a2d9
BLAKE2b-256 5f7e1a4c6f05da03e089ae6a0016bfa1ba1b87595320ab8d55ee784c621248c8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for release_note_automator-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 bb57cddd770a9440fcb9e5d698f4152b2aee97449d396dca148ea491b2484d0f
MD5 65977432bc5ef335003f8e0e731a7663
BLAKE2b-256 ee0489e63d38d95a0dfe2714d98cf24cbee121b5bc8c4e55577222180175fa8f

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