uug-ai/Generate Release Notes with AI
Generate release notes by comparing releases across multiple repositories using (Azure) OpenAI
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github_token | The GitHub token for accessing repositories | yes | — |
| repositories | JSON array of repository configurations. Each item should have: repo (owner/repo), from_release, to_release. Example: [{"repo": "owner/repo1", "from_release": "v1.0.0", "to_release": "v1.1.0"}] | no | [] |
| raw_diffs | JSON array of raw diff objects to include in release notes. Each item should have: name (filename or identifier), diff (the diff content). Example: [{"name": "config.yaml", "diff": "@@ -1,3 +1,5 @@..."}] | no | [] |
| openai_api_key | OpenAI API key (leave empty if using Azure OpenAI) | no | "" |
| azure_openai_api_key | Azure OpenAI API key (leave empty if using OpenAI) | no | "" |
| azure_openai_endpoint | Azure OpenAI endpoint to use | no | "" |
| azure_openai_version | Azure OpenAI API version to use | no | 2024-02-15-preview |
| openai_model | OpenAI model to use (needs to be compatible with the chat/completions endpoint) | no | gpt-4o |
| max_tokens | Maximum number of tokens for the completion | no | 2000 |
| temperature | Temperature for the model (0-2), higher values make output more creative | no | 0.6 |
| release_title | Title for the combined release notes | no | Release Notes |
| include_diff_stats | Include diff statistics (files changed, insertions, deletions) in output | no | true |
| custom_prompt | Custom prompt to use for generating release notes (optional) | no | "" |
| frontend_context_file | Path to a .txt file containing a description of the frontend application (pages, features, functionality). Used to generate a targeted test plan based on the changes. | no | "" |
| generate_test_plan | Generate a test plan based on the changes and frontend context | no | false |
Outputs
| name | description |
|---|---|
| release_notes | The generated release notes markdown |
| summary | A brief summary of all changes |
| test_plan | The generated test plan markdown (if frontend_context_file is provided and generate_test_plan is true) |