Skip to content

Latest commit

 

History

History
12 lines (8 loc) · 1.64 KB

Migration.md

File metadata and controls

12 lines (8 loc) · 1.64 KB

Migrating Between Versions

Migrating from Aardvark 3.x / CoreAardvark 2.x

The biggest change in the Aardvark 4.0 family is the reorganization of files between frameworks. This release introduced two new frameworks: AardvarkMailUI and AardvarkLoggingUI. Both of these frameworks were released with a version number of 1.0. You will likely need to update your dependencies to include one or more of these new frameworks, depending which components of Aardvark you were previously using. By breaking Aardvark down into smaller frameworks, you can now specify which components you want to add a depenedency on to a greater degree, since each framework has a well-defined scope. For example, you should only add a dependency on AardvarkLoggingUI if you present the in-app log viewer. Most apps will want to add a dependency on AardvarkMailUI when migrating, but it's now easier to build a custom bug reporter implementation, so you may choose to transition off of the mail-based bug reporting flow in the future.

In addition, there are a handful of breaking changes in the API:

  • ARKEmailAttachment was renamed to ARKBugReportAttachment.
  • ARKEmailBugReporter.attachesViewHierarchyDescriptionWithScreenshot was renamed to ARKEmailBugReporter.attachesViewHierarchyDescription. This also represents a change in when the view hierarchy is attached (it no longer depends on the screenshot also being attached).
  • The initializer for ARKLogMessage now takes an additional parameters argument. This allows for attaching a persisted string dictionary to the log message.
  • ARKLogStore has a new designated initializer that takes a file URL for the persisted log file.