https://github.com/barredterra/pretty_release_notes

Turn GitHub's auto-generated release notes into human-readable sentences.
https://github.com/barredterra/pretty_release_notes

Last synced: about 2 months ago
JSON representation

Turn GitHub's auto-generated release notes into human-readable sentences.

• Host: GitHub
• URL: https://github.com/barredterra/pretty_release_notes
• Owner: barredterra
• License: mit
• Created: 2024-10-23T12:45:42.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-10-30T14:33:27.000Z (about 2 months ago)
• Last Synced: 2024-10-30T15:32:44.775Z (about 2 months ago)
• Language: Python
• Size: 3.91 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Turn GitHub's auto-generated release notes into human-readable sentences.

> [!WARNING]

> Currently, the prompt and default parameters are geared towards [ERPNext](https://github.com/frappe/erpnext) and the [Frappe Framework](https://github.com/frappe/frappe). If you want to use this for different projects, please fork and adjust to your liking.

## Configuration

Copy `.env.example` to `.env` and fill in your GitHub token and OpenAI API key.

## Usage

```bash

source env/bin/activate

python main.py --help

python main.py erpnext v15.38.4

python main.py --owner alyf-de banking v0.0.1

```

Example output:

```markdown

---- Original ----

## What's Changed

* fix: list view and form status not same for purchase order (backport #43690) (backport #43692) by @mergify in https://github.com/frappe/erpnext/pull/43706

**Full Changelog**: https://github.com/frappe/erpnext/compare/v15.38.3...v15.38.4

---- Modified ----

## What's Changed

* We have fixed an issue where the status in the **Purchase Order** list view differed from the form, ensuring both now accurately reflect the _To Bill_ status as intended. https://github.com/frappe/erpnext/pull/43706

**Full Changelog**: https://github.com/frappe/erpnext/compare/v15.38.3...v15.38.4

```

> [!NOTE]

> Currently we only support release notes as generated by GitHub (bullet points with the PR URL at the end).