Skip to content

Generate release notes files from PR titles - #776

Draft
iangmaia wants to merge 6 commits into
trunkfrom
iangmaia/generate-release-notes-from-prs
Draft

iangmaia wants to merge 6 commits into
trunkfrom
iangmaia/generate-release-notes-from-prs

Conversation

@iangmaia

@iangmaia iangmaia commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

What does it do?

Adds generate_release_notes_file for existing release lanes, addressing AINFRA-3084.

It writes the Markdown returned by get_prs_between_tags directly under a version heading in RELEASE-NOTES.txt, preserving other versions.
This implementation supports label exclusions, category headings, and previews, and API errors leave the file untouched.

Also fixes the configuration-path parameter sent to GitHub.

Initial implementation on the app side: woocommerce/woocommerce-android#16630

Checklist before requesting a review

  • Run bundle exec rubocop to test for code style violations and recommendations.
  • Add Unit Tests (aka specs/*_spec.rb) if applicable.
  • Run bundle exec rspec to run the whole test suite and ensure all your tests pass.
  • Make sure you added an entry in the CHANGELOG.md file to describe your changes under the appropriate existing ### subsection of the existing ## Trunk section.
  • If applicable, add an entry in the MIGRATION.md file to describe how the changes will affect the migration from the previous major version and what the clients will need to change and consider. Not applicable: no breaking changes.

@iangmaia iangmaia self-assigned this Sep 29, 2026
@dangermattic

Copy link
Copy Markdown
Collaborator
1 Message
📖 This PR is still a Draft: some checks will be skipped.

Generated by 🚫 Danger

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟢 Approval recommended

The implementation matches its stated behavior and has thorough coverage of updates, previews, formatting, validation, and failures.

Review effort: Balanced
Findings: None

What changed in this PR

Adds a Fastlane action that generates and safely updates versioned release notes from GitHub PR data.

Changes:

  • Adds release-note generation with preview, validation, newline preservation, and failure safety.
  • Corrects the GitHub configuration path parameter.
  • Adds comprehensive RSpec coverage and changelog entries.
File Description
CHANGELOG.md Documents the feature and parameter fix.
lib/​.../​generate_release_notes_file.rb Implements the new Fastlane action.
lib/​.../​github_helper.rb Corrects the GitHub API parameter.
lib/​.../​release_notes_helper.rb Adds version-section replacement and insertion.
spec/​generate_release_notes_file_spec.rb Tests generation behavior and failure cases.
spec/​get_prs_between_tags_spec.rb Updates expectations for the corrected parameter.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants