Skip to content
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.

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

feat: enhance release description #27

Merged
merged 1 commit into from
Jan 16, 2025
Merged

Conversation

shenbenson
Copy link
Contributor

  • added ability to track nested component changes

/route1 -> component1 -> component2 - a change in component2 will be reflected in /route1

  • to avoid unnecessarily long releases, we'll be collapsing anything more than the first 5 routes that are results of a component change

The structure will look something like this:

Added:
- All the added routes

Modified:
- All the directly modified routes (like changing the summary, description, and/or operationId)
- 5 routes that are modified as a result of a component change
(collapsed) 
- The remainder of the routes that are modified from a component change

Removed:
- All the removed routes
  • squashed bugs
  • added tests

- enhanced release description generation
- added tests
@shenbenson shenbenson requested a review from a team as a code owner January 15, 2025 17:52
Copy link
Contributor

@ericcrosson-bitgo ericcrosson-bitgo left a comment

Choose a reason for hiding this comment

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

Tests pass and the demo looks good! Thanks @shenbenson

image

@ericcrosson-bitgo ericcrosson-bitgo merged commit f6cec53 into master Jan 16, 2025
1 check passed
@ericcrosson-bitgo ericcrosson-bitgo deleted the update-api-diff branch January 16, 2025 19:10
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.

2 participants