Changelog Generator

Generate a fun, engaging changelog for an internal development team by summarizing the latest merges to the main branch, highlighting new features, bug fixes, and giving credit to the developers.

Time Period

• For daily changelogs: Look at PRs merged in the last 24 hours
• For weekly summaries: Look at PRs merged in the last 7 days
• Always specify the time period in the title (e.g., "Daily" vs "Weekly")
• Default: Get the latest changes from the last day from the main branch of the repository

PR Analysis

Analyze the provided GitHub changes and related issues. Look for:

1. New features that have been added
2. Bug fixes that have been implemented
3. Any other significant changes or improvements
4. References to specific issues and their details
5. Names of contributors who made the changes
6. Use gh cli to lookup the PRs as well and the description of the PRs
7. Check PR labels to identify feature type (feature, bug, chore, etc.)
8. Look for breaking changes and highlight them prominently
9. Include PR numbers for traceability
10. Check if PRs are linked to issues and include issue context

Content Priorities

1. Breaking changes (if any) - MUST be at the top
2. User-facing features
3. Critical bug fixes
4. Performance improvements
5. Developer experience improvements
6. Documentation updates

Formatting Guidelines

Create a changelog summary with the following guidelines:

1. Keep it concise and to the point
2. Highlight the most important changes first
3. Group similar changes together (e.g., all new features, all bug fixes)
4. Include issue references where applicable
5. Mention the names of contributors, giving them credit for their work
6. Add a touch of humor or playfulness to make it engaging
7. Use emojis sparingly to add visual interest
8. Keep total message under 2000 characters for Discord
9. Use consistent emoji for each section
10. Format code/technical terms in backticks
11. Include PR numbers in parentheses (e.g., "Fixed login bug (#123)")

Deployment Notes

When relevant, include:

• Database migrations required
• Environment variable updates needed
• Manual intervention steps post-deploy
• Dependencies that need updating

The final output should be formatted as follows:

<change_log>

🚀 [Daily/Weekly] Change Log: [Current Date]

🚨 Breaking Changes (if any)

[List any breaking changes that require immediate attention]

🌟 New Features

[List new features here with PR numbers]

🐛 Bug Fixes

[List bug fixes here with PR numbers]

🛠️ Other Improvements

[List other significant changes or improvements]

🙌 Shoutouts

[Mention contributors and their contributions]

🎉 Fun Fact of the Day

[Include a brief, work-related fun fact or joke]

</change_log>

Style Guide Review

Review the changelog using the EVERY_WRITE_STYLE.md file and go one by one to ensure adherence to the style guide. Use multiple agents, run in parallel to make it faster.

Remember, the final output should only include the content within the <change_log> tags. Do not include any thought process or original data in the output.

Discord Posting (Optional)

Post changelogs to Discord by adding a webhook URL:

First get the webhook URL with printenv DISCORD_WEBHOOK_URL, then post using curl with the literal URL:

curl -H "Content-Type: application/json" \
  -d "{\"content\": \"{{CHANGELOG}}\"}" \
  "<webhook-url>"

Replace <webhook-url> with the actual Discord webhook URL.

To get a webhook URL, go to Discord server > Server Settings > Integrations > Webhooks > New Webhook.

Error Handling

• If no changes in the time period, post a "quiet day" message: "🌤️ Quiet day! No new changes merged."
• If unable to fetch PR details, list the PR numbers for manual review
• Always validate message length before posting to Discord (max 2000 chars)

Schedule Recommendations

• Run daily at 6 AM NY time for previous day's changes
• Run weekly summary on Mondays for the previous week
• Special runs after major releases or deployments

Audience Considerations

Adjust the tone and detail level based on the channel:

• Dev team channels: Include technical details, performance metrics, code snippets
• Product team channels: Focus on user-facing changes and business impact
• Leadership channels: Highlight progress on key initiatives and blockers