Skip to content

Release Steps

Joel Fischer edited this page Jun 3, 2016 · 34 revisions

When working on a new release, there are a few steps that need to be taken. This should eventually be wrapped up in a script, but for now it's manual. See this example commit.

  1. Run clang-format using the style file in the github repository. In terminal, run the script like this: clang-format -i -style=file ./SmartDeviceLink-iOS/SmartDeviceLink/*.

  2. The project file's version should be bumped to the new version number according to semantic versioning 2.0.0. Change the version in the xcode project version field

  3. Change the version in SDLProxy.m.

  4. Change the version number in the podspec.

  5. Change the README to reference the most current version.

  6. Add the exhaustive changes to the CHANGELOG file.

  7. Generate Jazzy Documentation using (from the script directory) bash generate-documentation.sh.


After committing the new release and tagging it:

  1. Create a new release for the tag and add the highlights of the changes. For example, if there are breaking changes, any new features, or major changes / bugfixes.

  2. Push the new release to cocoapods using command line: pod trunk push SmartDeviceLink-iOS.podspec.

  3. Add a binary archive to the release for Carthage using this guide. (Double-check that this is now automatic)

  4. Add the docset to the release.

Clone this wiki locally