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

Update CHANGELOG #1827

Merged
merged 5 commits into from
Feb 21, 2023
Merged

Update CHANGELOG #1827

merged 5 commits into from
Feb 21, 2023

Conversation

hannahramadan
Copy link
Contributor

Update CHANGELOG to add feedback given in the migration guide

Before contributing, please read our contributing guidelines and code of conduct.

Overview

Describe the changes present in the pull request

Submitter Checklist:

  • Include a link to the related GitHub issue, if applicable
  • Include a security review link, if applicable

Testing

The agent includes a suite of unit and functional tests which should be used to
verify your changes don't break existing functionality. These tests will run with
GitHub Actions when a pull request is made. More details on running the tests locally can be found
here for our unit tests,
and here for our functional tests.
For most contributions it is strongly recommended to add additional tests which
exercise your changes.

Reviewer Checklist

  • Perform code review
  • Add performance label
  • Perform appropriate level of performance testing
  • Confirm all checks passed
  • Add version label prior to acceptance

Update CHANGELOG to add feedback given in the migration guide
@hannahramadan hannahramadan marked this pull request as ready for review February 17, 2023 01:10
CHANGELOG.md Outdated Show resolved Hide resolved
Copy link
Contributor

@kaylareopelle kaylareopelle left a comment

Choose a reason for hiding this comment

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

Found a few small things. The bug fix entry links to the PR twice.

CHANGELOG.md Outdated
- **Add Fiber Instrumentation**
This may be a breaking change if you are currently using custom thread instrumentation. New transactions inside of threads will no longer be started if one already exists. [PR#1767](https://github.com/newrelic/newrelic-ruby-agent/pull/1767)

- **Add Fiber instrumentation**

`Fiber` instances are now automatically instrumented similarly to `Thread` instances. This can be configured using `instrumentation.fiber`. [PR#1802](https://github.com/newrelic/newrelic-ruby-agent/pull/1802)
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't know how it looks on the docs website, but I think GitHub now supports links within single back tick code snippets.

All this is to say, what do you think about linking the config options to their location on our config doc?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll have to look into the single back tick. But the config option is now linked. Note: the docs site isn't live yet so the link doesn't work quite yet.

CHANGELOG.md Show resolved Hide resolved
CHANGELOG.md Outdated Show resolved Hide resolved
@github-actions
Copy link

SimpleCov Report

Coverage Threshold
Line 93.94% 93%
Branch 85.37% 84%

1 similar comment
@github-actions
Copy link

SimpleCov Report

Coverage Threshold
Line 93.94% 93%
Branch 85.37% 84%

@hannahramadan hannahramadan merged commit a373cdc into dev Feb 21, 2023
@hannahramadan hannahramadan deleted the update_changelog_9_0_0 branch March 2, 2023 17:35
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.

None yet

3 participants