-
Notifications
You must be signed in to change notification settings - Fork 117
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
Updated CHANGELOG for release v1.7.1 #377
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just some small comments on semver stuff, it's not too important but good practice in general
CHANGELOG.md
Outdated
@@ -7,6 +7,20 @@ Unreleased | |||
### SDK Bugs | |||
|
|||
|
|||
Release v1.8.0 (2022-09-13) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix date
CHANGELOG.md
Outdated
* Added OTel Go links to readme [#PR 369](https://github.com/aws/aws-xray-sdk-go/pull/369) | ||
* Added segment creation in instrumentation example [#PR 370](https://github.com/aws/aws-xray-sdk-go/pull/370) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changes that don't impact the behavior of the SDK should not be included in the changelog
================================ | ||
### SDK Enhancements | ||
* Replace error type assertions with errors.As in DefaultFormattingStrategy [#PR 353](https://github.com/aws/aws-xray-sdk-go/pull/353) | ||
* Dummy segments don't need cancel go routine [#PR 365](https://github.com/aws/aws-xray-sdk-go/pull/365) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For each change, if it would be considered a PATCH change by the definitions of https://semver.org/, it should be considered a bug fix. For example, I think this would probably be considered a backwards-compatible bug fix rather than adding functionality
Also seems 1 test suite is failing - probably something transient with GH runner |
@@ -7,6 +7,17 @@ Unreleased | |||
### SDK Bugs | |||
|
|||
|
|||
Release v1.7.1 (2022-09-14) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry I should have been more clear - basically what we want to do is go through each change, and decide if it's an "enhancement" or a "bug fix" based on the semver definition, and put it under the appropriate header.
Then, if there are any "enhancements" in this release, it should be a MINOR version (1.8.0). If it's all bug fixes, it's just a patch (1.7.1). Please let me know if you have any questions!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep looks good, I think it's a patch
Issue #, if available:
Description of changes:
Updating the changelog for v1.7.1
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.