Skip to content

Commit

Permalink
reorganize CHANGELOG by category
Browse files Browse the repository at this point in the history
I think any empty categories should be deleted at release time.

These are based on whats at https://keepachangelog.com/en/1.1.0/,
because that's what was mentioned on the technical steering call, but I
don't have strong feelings about this
  • Loading branch information
michaelkirk committed Aug 15, 2024
1 parent 1b072e8 commit d9d6cb1
Showing 1 changed file with 25 additions and 4 deletions.
29 changes: 25 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
# Changes to the Mapbox Navigation SDK for iOS

## Unreleased

### Added

* Start & Stop Navigation in existing Map
- Removed: `NavigationViewController(for route: Route, dayStyle: Style, routeController: RouteController? = nil, locationManager: NavigationLocationManager? = nil, voiceController: RouteVoiceController? = nil)` use `NavigationViewController(dayStyleURL: URL, nightStyleURL: URL? = nil,directions: Directions = .shared, voiceController: RouteVoiceController = RouteVoiceController())` followed by `startNavigation(with route: Route, animated: Bool)` instead.
- To simulate a route, pass a `SimulatedLocationManager` to `startNavigation()` function:

```swift
#if targetEnvironment(simulator)
#if targetEnvironment(simulator)
let locationManager = SimulatedLocationManager(route: route)
locationManager.speedMultiplier = 2
self.startNavigation(with: route, animated: false, locationManager: locationManager)
Expand All @@ -15,13 +18,33 @@
#endif
```
* Custom location snapping in the `RouteController` via the delegate

### Changed

* Only require background audio when using speech synthesis in https://github.com/maplibre/maplibre-navigation-ios/pull/64
* Adjusted the camera during navigation to show more of what's "ahead" in the route - effectively moving the puck lower on the screen. As before, see `NavigationMapViewCourseTrackingDelegate.updateCamera(_:location:,routeProgress:)` if you want to customize this behavior.
- Merged in <https://github.com/maplibre/maplibre-navigation-ios/pull/92>

### Deprecated

* None

### Removed

* None

### Fixed

* Fix: If the directions API endpoint doesn't include audio instructions, `didArrive:` would never be called.
* Merged in <https://github.com/maplibre/maplibre-navigation-ios/pull/72>
* Only require background audio when using speech synthesis in https://github.com/maplibre/maplibre-navigation-ios/pull/64
* Fix: Respond to changes in dynamic type without having to restart the app in https://github.com/maplibre/maplibre-navigation-ios/pull/65
* Fix: crash in EndOfRouteViewController and restore its presentation by in https://github.com/maplibre/maplibre-navigation-ios/pull/71
* Fix: retain cycles in RouteMapViewController

### Security

* None

## 3.0.0 (Jun 15, 2024)
* The `speak` method in `RouteVoiceController` can be used without a given `RouteProgress` or the `RouteProgress` can explicitly ignored so that it will not be added to the voice instruction.
* `RouteProgress` is now optional in `willSpeak` method of `VoiceControllerDelegate` if the `RouteProgress` in the `speak` method of the `RouteVoiceController is `nil`.
Expand All @@ -46,8 +69,6 @@
- Merged in <https://github.com/maplibre/maplibre-navigation-ios/pull/47>
* Fix: NavigationViewController displayed incorrect `speedMultiplier` when using SimulatedLocationManager
- Merged in <https://github.com/maplibre/maplibre-navigation-ios/pull/49>
* Adjusted the camera during navigation to show more of what's "ahead" in the route - effectively moving the puck lower on the screen. As before, see `NavigationMapViewCourseTrackingDelegate.updateCamera(_:location:,routeProgress:)` if you want to customize this behavior.
- Merged in <https://github.com/maplibre/maplibre-navigation-ios/pull/92>

## v2.0.0 (May 23, 2023)
* Upgrade minimum iOS version from 11.0 to 12.0.
Expand Down

0 comments on commit d9d6cb1

Please sign in to comment.