Search code, repositories, users, issues, pull requests...

@benjaminmah benjaminmah commented Mar 3, 2025

Copy link

Copy Markdown

Contributor

Includes both the tool (bugbug/tools/release_notes.py) and the runner (scripts/release_notes_runner.py).

Takes two parameters:
--version - the version of Firefox to generate a list of potential commits to include in release notes (e.g. FIREFOX_BETA_136_BASE)
--chunk-size - the size of the chunk (in tokens) when passing in the commit logs to the LLM

benjaminmah added 20 commits

January 23, 2025 15:02


 Initial working release notes generator

218ddfc


 Fixed prompt and list generation

51e7f34


 Fixed prompt and excluded Nightly

6af501b


 Added duplicate remover

98ea3a9


 Added additional filtering

a8e9880


 Fixed prompt to clean

afd0d2c


 Added extra conversation

ce3bdce


 New prompt

bc1dd9c


 Changed prompt

6ba5b88


 Made prompt more strict

be742b1


 Fixed prompt and increased chunk size

1dacebf


 Removed asterisks

4f0e081


 Changed version

821790c


 Added bug filtering for webextensions

34e366a


 Edited prompt

27204d1


 Separated release notes into a runner and tool, updated the method to...

2033b89

... filter out bugs behind features that are not yet shipped


 Fixed up runner to take in only one version

7638d2a


 Moved version to the function

d9f6831


 Fixed release notes script to make use of URL instead of local repo

93a5982


 Removed old script

2b702fe

@benjaminmah benjaminmah requested a review from suhaibmujahid

March 3, 2025 21:01

suhaibmujahid requested changes

Mar 3, 2025

bugbug/tools/release_notes.py Outdated


 Removed HTML parsing with json

35ad073

@benjaminmah benjaminmah requested a review from suhaibmujahid

March 4, 2025 03:04

suhaibmujahid reviewed

Mar 5, 2025

bugbug/tools/release_notes.py Outdated

benjaminmah added 5 commits

March 4, 2025 22:50


 Removed .get and response 200

2d0030c


 Made input and output list instead of string

fbb3c30


 Using LangChain

3d6f4d0


 Using data.values()

c220bb3


 Added LLMChain

1bf92b2


 Changed output to be a list and JSON

0da3e8a

suhaibmujahid reviewed

functions/release_notes/main.py Outdated

suhaibmujahid reviewed

functions/release_notes/main.py Outdated

suhaibmujahid reviewed

bugbug/generative_model_tool.py Outdated

benjaminmah added 2 commits

April 15, 2025 21:55


 Addressed PR comments

1d6ecc6


 Simplified LLM creation

9b07b5b

suhaibmujahid reviewed

bugbug/tools/release_notes.py Outdated

suhaibmujahid reviewed

bugbug/tools/release_notes.py Outdated


 Replaced DB with Bugzilla calls

e852e9d

@benjaminmah benjaminmah requested a review from suhaibmujahid

April 21, 2025 13:55

suhaibmujahid reviewed

functions/release_notes/main.py Outdated

suhaibmujahid reviewed

functions/release_notes/main.py Outdated

suhaibmujahid reviewed

functions/release_notes/main.py Outdated

suhaibmujahid reviewed

functions/release_notes/requirements.txt Outdated

suhaibmujahid reviewed

functions/release_notes/requirements.txt Outdated

suhaibmujahid reviewed

bugbug/tools/release_notes.py Outdated

suhaibmujahid reviewed

bugbug/tools/release_notes.py Outdated


 Addressed PR comments

11a6444

@benjaminmah benjaminmah requested a review from suhaibmujahid

April 23, 2025 19:29

suhaibmujahid reviewed

functions/release_notes/main.py Outdated

suhaibmujahid reviewed

bugbug/tools/release_notes.py Outdated

return "\n".join(unique_lines)

def get_final_release_notes_commits(

self, target_version: str

@suhaibmujahid suhaibmujahid Apr 27, 2025

Copy link

Copy Markdown

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would taking the release and the channel separately, instead of one string, be cleaner?

@benjaminmah benjaminmah Apr 27, 2025

Copy link

Copy Markdown

Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the way we're getting the commit logs from the URL, it should be fine. However, if you think it would be better, I can change it to have two inputs rather than a single string for the release and channel.

@suhaibmujahid suhaibmujahid Apr 29, 2025

Copy link

Copy Markdown

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be clear from an API point of view.

@benjaminmah benjaminmah Apr 29, 2025

Copy link

Copy Markdown

Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done here: 38499c3

suhaibmujahid reviewed

bugbug/tools/release_notes.py Outdated

bug_ids = []

for desc, _, _ in commit_log_list:

match = re.search(r"Bug (\d+)", desc, re.IGNORECASE)

@suhaibmujahid suhaibmujahid Apr 27, 2025

Copy link

Copy Markdown

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We parse the commit message twice, once here and again in filter_irrelevant_commits(). It would be nice to do it once here; we could have a list of structured data about each commit, e.g., a tuple or dict with the bug number and message.

@benjaminmah benjaminmah Apr 27, 2025

Copy link

Copy Markdown

Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done here! aebee0a

suhaibmujahid reviewed

bugbug/tools/release_notes.py Outdated

suhaibmujahid reviewed

bugbug/tools/release_notes.py Outdated

suhaibmujahid reviewed

bugbug/tools/release_notes.py Outdated

benjaminmah added 2 commits

April 27, 2025 17:04


 Addressed PR comments

aebee0a


 Changed input to have channel and release separately

38499c3

suhaibmujahid reviewed

Apr 29, 2025

bugbug/tools/release_notes.py Outdated

Comment on lines +32 to +43

def get_previous_version(target_version: str) -> str:

match = re.search(r"(\d+)", target_version)

if not match:

raise ValueError("No number found in the version string")

number = match.group(0)

decremented_number = str(int(number) - 1)

return (

target_version[: match.start()]

+ decremented_number

+ target_version[match.end() :]

)

@suhaibmujahid suhaibmujahid Apr 29, 2025

Copy link

Copy Markdown

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this still needed?

@benjaminmah benjaminmah Apr 29, 2025

Copy link

Copy Markdown

Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, thank you for pointing this out. I've removed it!

suhaibmujahid reviewed

Apr 29, 2025

tests/test_release_notes.py Outdated

def test_get_previous_version():

assert get_previous_version("FIREFOX_BETA_135_BASE") == "FIREFOX_BETA_134_BASE"

assert get_previous_version("FIREFOX_NIGHTLY_132") == "FIREFOX_NIGHTLY_131"

assert get_previous_version("FIREFOX_RELEASE_130_2") == "FIREFOX_RELEASE_129_2"

@suhaibmujahid suhaibmujahid Apr 29, 2025

Copy link

Copy Markdown

Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How do we now handle cases like FIREFOX_RELEASE_130_2?

@benjaminmah benjaminmah Apr 29, 2025

Copy link

Copy Markdown

Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I just had that case there to make sure the string parsing was correct. Now that we specify the channel and release separately, would there be a case of FIREFOX_RELEASE_130_2 or FIREFOX_RELEASE_130_2_BASE? I've tried to retrieve the commits from the URL using these but was unable to (maybe because these do not exist?).