Skip to content

fix issues with the AI-generated changelog #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 30, 2025
Merged

fix issues with the AI-generated changelog #21

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
42ce963
fix: avoid having the AI invent a release name and version
pshariat Jan 30, 2025
934527c
fix: avoid having the AI use colors in slack changelogs
pshariat Jan 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions changelog_generator/ai_generator.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,14 @@

PROMPT = (
"Here's a git diff between two versions (represented as git tags). "
"Write a summary of this diff by following this structure "
"Write a summary of this diff by following this structure. Do not add any new section."
"A TL;DR section with very few lines expressing the salient points of your analysis "
"A Functional Changes section that should be understandable by readers that have no technical knowledge "
"A section about possible regressions that could appear : this section should aim to be brief as it might be used during a production incident, but it musn't be too generic either"
"A section about key kong/log metrics that should be observed during the production release process, these must be very precise"
"The summary must be written with github and slack compatible markdown. It should be pleasing and give priority to salient points, must use colors and must use tasteful fonts, and follow best practices. You can use UML schemas and diagrams."
"The summary must be written with github and slack compatible markdown. It should be pleasing and give priority to salient points. It may use emojis but no colors or fonts."
"Do not print a description of each commit, the goal is to be as concise as possible. Do not take more than 200 words."
"Do not try to infer the name and version of the release."
)

SCOPES = [
Expand Down