RELEASE.md

Release process

Shipping a new version

Once we have a build on master we want to publish:

0. Bump the CardScan.podspec with the new version of our library

1. Run CardScan systems iOS test. Make sure to watch the videos to double check that everything looks good.

2. If a new file is added in CardScan/, run pod install and commit the newly created Pod/ directory

3. Verify Carthage build is working in the same directory as .xcodeproj

   carthage build --no-skip-current

   • If you get the error: no shared framework schemes, reclick shared on the project schemes in xcode.
   • Make sure to commit files that are modified after reclicking shared

4. Run the Cocoapods linter to make sure that everything is going to pass

   pod lib lint

5. Tag release

   git tag <version>
   git push --tags

6. Update the changelog automatically

   # checkout https://github.com/github-changelog-generator/github-changelog-generator for installation instructions
   # put your github token in a file called github_token in the base directory
   # run:
   github_changelog_generator -u getbouncer -p cardscan-ios -t `cat github_token` 

7. Check the updated Changelog manually and update any entries that need updating.

8. Publish to CocoaPods

   pod trunk push

Bumping a model

1. Put the new model in the OriginalModels directory

2. Remove the old compiled version from the resources directory

   rm -rf CardScan/Assets/FindFour.mlmodelc

3. Compile the new model

   xcrun coremlc compile OriginalModels/FindFour.mlmodel CardScan/Assets