(EAI-348) Summarize Release Artifacts

[nlarew]

Jira

• (EAI-321) POC - Git commits/PRs for Specific Release
• (EAI-322) POC - Code Diffs for Specific Release
• (EAI-320) POC - Jira Issues for Specific Release
• (EAI-348) Summarize Release Artifacts

Changes

• Release info is defined in yaml and passed in via --releaseInfo ./path/to/file.yaml
• Sources git commits/patches & jira issues for a release
• Summarizes release artifacts with GPT-4
• Does not yet:
  • generate a thorough, structured changelog
  • generate user-facing release notes

How to use

Env Vars

You need the following new .env vars + the rest of .env.example

• GITHUB_ACCESS_TOKEN
• JIRA_USERNAME
• JIRA_PASSWORD

The GitHub token you can make yourself (https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens). I can send you jira creds.

First time CLI setup

cd mongodb-artifact-generator
npm install
npm link # makes mongodb-ai binary available in your shell

Generate release note artifact summaries

mongodb-ai generateReleaseNotes \
  --runId="my-run \
  --releaseInfo="./context/release-notes/atlas-cli-releaseInfo.yaml" 

The POC run takes around 45 seconds to summarize 31 artifacts. There are console logs to track progress.

When the run is complete, the generated artifacts are available in the runlogs/generateReleaseNotes/<runId> directory.

[nlarew]

i wonder if we could add a LLM function call that tries to determine if a change is public facing. think chain-of-thought prompting could figure that out reasonably well.

maybe also a function call that tries to determine type of change. i/e bug fix, feature, etc.

Good idea! I'll look at implementing that in the changelog piece I'm working on now