Release Steps
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.
-
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/*. -
The project file's version should be bumped to the new version number according to semantic versioning 2.0.0. The example project should also be bumped.
-
Change the version in SDLProxy.m.
-
Change the version number in the podspec.
-
Change the README to reference the most current version.
-
Add the exhaustive changes to the CHANGELOG file.
-
Generate Jazzy Documentation using (from the script directory)
bash generate-documentation.sh.
After committing the new release and tagging it:
-
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.
-
Push the new release to cocoapods using command line:
pod trunk push SmartDeviceLink-iOS.podspec. -
Add a binary archive to the release for Carthage using this guide. You may need to run specifically:
carthage archive --project-directory ./ -
Add the docset to the release.