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

Updated CHANGELOG for release v1.7.1 #377

Merged
merged 5 commits into from
Sep 14, 2022
Merged

Updated CHANGELOG for release v1.7.1 #377

merged 5 commits into from
Sep 14, 2022

Conversation

atshaw43
Copy link
Contributor

@atshaw43 atshaw43 commented Sep 13, 2022

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.

@atshaw43 atshaw43 requested a review from a team as a code owner September 13, 2022 23:36
Copy link
Contributor

@willarmiros willarmiros left a 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)
Copy link
Contributor

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
Comment on lines 16 to 17
* 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)
Copy link
Contributor

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)
Copy link
Contributor

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

@willarmiros
Copy link
Contributor

Also seems 1 test suite is failing - probably something transient with GH runner

@atshaw43 atshaw43 changed the title Updated CHANGELOG for release v1.8.0 Updated CHANGELOG for release v1.7.1 Sep 14, 2022
@@ -7,6 +7,17 @@ Unreleased
### SDK Bugs


Release v1.7.1 (2022-09-14)
Copy link
Contributor

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!

Copy link
Contributor

@willarmiros willarmiros left a 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

@atshaw43 atshaw43 merged commit d290222 into master Sep 14, 2022
@atshaw43 atshaw43 deleted the atshaw43 branch September 15, 2022 19:04
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