git/changelog_generator_simple
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
1 commit 1 branch 0 tags 29 KiB
Find a file
Exact
Patryk Hegenberg 60760d4880 initial commit to copy repo
2024-09-23 16:29:59 +02:00
ai_generator.py initial commit to copy repo 2024-09-23 16:29:59 +02:00
env.example initial commit to copy repo 2024-09-23 16:29:59 +02:00
README.md initial commit to copy repo 2024-09-23 16:29:59 +02:00

README.md

Changelog Generator

Description

This Python script allows you to generate changelogs and release notes based on Redmine tickets. It uses the OpenAI API to automatically create the changelog entries.

Features

  • Retrieve projects and versions from Redmine
  • Retrieve tickets for a specific project and version
  • Generate changelog entries based on the ticket information using the OpenAI API
  • Output the changelog in AsciiDoc format

Prerequisites

  • Python 3.x
  • The following Python packages:
    • urllib
    • json
    • dotenv
    • ssl
    • argparse
  • Redmine API key
  • OpenAI API key

Usage

  1. Copy the .env.example file and rename it to .env. Fill in the environment variables REDMINE_HOST, REDMINE_API_KEY, and OPENAI_API_KEY with your access credentials.
  2. Run the script with the following arguments:
  • -p, --project: The project ID for which the changelog should be generated.
  • -f, --fixed-version: The version ID for which the changelog should be generated.
  • -t, --type: The type of text to be generated (Changelog or Release Notes).
  1. If you don't provide a project ID or version ID, a list of available projects and versions will be displayed for you to choose from.
  2. The generated changelog will be output in AsciiDoc format on the console.

Examples

python3 changelog_generator.py -p 47 -f 755 -t Changelog
python3 changelog_generator.py -p 47 -f 755 -t ReleaseNotes