Skip to content

Latest commit

 

History

History
47 lines (36 loc) · 2.35 KB

RELEASE.md

File metadata and controls

47 lines (36 loc) · 2.35 KB
Raw

Release Process

Code level changes

  1. Create a new branch.
  2. Update the internal and marketing version: agvtool next-version -all && agvtool new-marketing-version $VERSION_NUMBER.
  3. Update *.podspec to appropriate new version.
  4. If this is a minor version, update versions in README.md and custom-navigation.md.
  5. In CHANGELOG.md, update master to the new version.
  6. Create a new PR.

Document

  1. Once the PR is merged, pull master locally.
  2. Create a new tag, example: git tag v0.16.0.
  3. Do not push the tag quite yet.
  4. Follow directions for updating the documentation.
  5. Push documentation changes. (These changes are pushed to the mb-pages branch)
  6. Push the tag: git push origin v0.16.1.

Making the releases

  1. Go to https://github.com/mapbox/mapbox-navigation-ios/releases
  2. Click Draft a new release
  3. In the Tag version dropdown, select the new tag you pushed.
  4. Copy the changes from CHANGELOG.md.
  5. Prepend the changes with: [Changes](https://github.com/mapbox/mapbox-navigation-ios/compare/v0.16.0...v0.16.1) since [v0.16.0](https://github.com/mapbox/mapbox-navigation-ios/releases/tag/v0.16.0):
  6. Append the changes with Documentation is [available online](https://www.mapbox.com/mapbox-navigation-ios/navigation/0.16.1) or within Xcode.
  7. Make sure you are using the appropriate version number

Pushing to CocoaPods

⚠️ Important: Order matters here ⚠️

  1. Update pods: pod repo update
  2. Push MapboxCoreNavigation: pod trunk push MapboxCoreNavigation.podspec
  3. Update pods: pod repo update
  4. Push MapboxNavigation: pod trunk push MapboxNavigation.podspec

Next steps

  1. Run pod update in the examples repository (and edit the Podfile if necessary) to install the latest version.
  2. See this wiki page for information on updating Mapbox documentation.