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.

Sign up for GitHub

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

Jump to bottom

Release notes quality issues #1031

Closed
jbelkins opened this issue Jun 6, 2023 · 1 comment
Closed

Release notes quality issues #1031

jbelkins opened this issue Jun 6, 2023 · 1 comment
Assignees
@jbelkins
Labels
bug This issue is a bug. ci/cd Continuous integration and continuous deployment
Milestone
GA

Comments

@jbelkins
Copy link
Contributor

jbelkins commented Jun 6, 2023

Describe the bug

Two issues in release notes to correct:

  • Bulleted items in release notes are surrounded by unnecessary quotes
  • The generated diff link for smithy-swift releases points to the aws-sdk-swift repo:
https://github.com/awslabs/aws-sdk-swift/compare/0.20.0...0.21.0

Expected Behavior

Release notes generate without extra quote marks & with correct links

Current Behavior

Release notes as currently generated:

## What's Changed
* "chore: Updates version to 0.21.0"
* "feat: Error revamp (#559)"
* "fix: Make data streams completely async (#553)"


**Full Changelog**: https://github.com/awslabs/aws-sdk-swift/compare/0.20.0...0.21.0

Reproduction Steps

Generate release notes on release & read.

Possible Solution

No response

Additional Information/Context

No response

AWS SWIFT SDK version used

0.18.0

Compiler and Version used

Xcode 14.3.1

Operating System and version

macOS 13.4
@jbelkins jbelkins added bug This issue is a bug. needs-triage This issue or PR still needs to be triaged. labels Jun 6, 2023
@jbelkins jbelkins added this to the GA milestone Jun 19, 2023
@jbelkins jbelkins added ci/cd Continuous integration and continuous deployment and removed needs-triage This issue or PR still needs to be triaged. labels Jun 19, 2023
@jbelkins jbelkins mentioned this issue Jun 22, 2023
Merged
@jbelkins jbelkins self-assigned this Jun 23, 2023
@jbelkins
Copy link
Contributor Author

jbelkins commented Jul 3, 2023

Shipped in AWS SDK for Swift 0.20.0

@jbelkins jbelkins closed this as completed Jul 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jbelkins jbelkins

Labels
bug This issue is a bug. ci/cd Continuous integration and continuous deployment
Projects
None yet
Milestone
GA
Development

No branches or pull requests
1 participant
@jbelkins