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

Lay out structure for property/method renames for v6.0 #435

Merged
merged 4 commits into from
Dec 10, 2019

Conversation

kattrali
Copy link
Contributor

@kattrali kattrali commented Nov 7, 2019

Goal

This changeset lays out an initial structure for the updates necessary to get the library ready for v6.0.0. The primary change in this major revision will be to rename some properties and methods to better align with other Bugsnag notifier libraries. These changes have been added in a backwards-compatible way to allow for incremental releases leading up to v6, when all deprecated properties will be removed.

Every change should be listed in the changelog and upgrade migration guide, and the new properties should replace the existing ones in the integration guide on docs.bugsnag.com.

Copy link
Contributor

@fractalwrench fractalwrench left a comment

Choose a reason for hiding this comment

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

This looks like a good way to track changes in an upgrade guide.

My understanding is that we don't need to introduce backward compatibility by deprecating properties, as we're not planning on releasing these changes until the React Native project is complete. As a general comment we could therefore skip adding the deprecation notices when we're going to remove them very shortly afterwards - we can discuss internally whether that is the right approach for Cocoa.

There are a few discrepancies with the spec that I've commented on inline.

CHANGELOG.md Show resolved Hide resolved
Source/BugsnagConfiguration.h Outdated Show resolved Hide resolved
Source/BugsnagSessionTracker.m Outdated Show resolved Hide resolved
Source/Bugsnag.h Outdated Show resolved Hide resolved
Source/Bugsnag.m Outdated Show resolved Hide resolved
@kattrali kattrali force-pushed the kattrali/rename-config-consistency branch 2 times, most recently from 8738bf8 to c3046ad Compare November 8, 2019 15:23
CHANGELOG.md Outdated Show resolved Hide resolved
UPGRADING.md Show resolved Hide resolved
@kattrali kattrali force-pushed the kattrali/rename-config-consistency branch from 7470260 to 8a15acc Compare December 5, 2019 16:36
@kattrali kattrali requested a review from tomlongridge December 9, 2019 15:37
Copy link
Contributor

@tomlongridge tomlongridge left a comment

Choose a reason for hiding this comment

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

LGTM

If this is going to be merged, does the changelog entry need a standard heading and/or some explanation to set the scene for these (and future) changes?

@kattrali kattrali merged commit e842b14 into master Dec 10, 2019
@kattrali kattrali deleted the kattrali/rename-config-consistency branch December 10, 2019 09:54
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