Home

Releases

Schedule

A new release will be made every other week assuming changes have been made since the last release.

Steps

• Draft a new github release:

  • Tag version should be vMAJOR.MINOR.PATCH
  • Release title should be MAJOR.MINOR.PATCH
  • Description should include what has changed since the last version

• Update the semantic version in the BNRCoreDataStack.podspec

• Tag the commit with the podspec bump change

  git tag -a -m '' vMAJOR.MINOR.PATCH
  git push -v origin refs/tags/vMAJOR.MINOR.PATCH
  

• Submit a PR with the pod spec changes

• Once merged, delete the tag from the first step

  git tag -d vMAJOR.MINOR.PATCH
  git push -v origin :refs/tags/vMAJOR.MINOR.PATCH
  

• Create the drafted Github Release

• Submit the updated pod spec

  pod trunk push BNRCoreDataStack.podspec

• Force a refresh of CocoaDocs

  curl http://api.cocoadocs.org:4567/redeploy/BNRCoreDataStack/MAJOR.MINOR.PATCH

Docs

The documentation is generated using this script.

Upon successful PR merges into master the script generates documentation using Jazzy and force pushes to the gh-pages branch. For this reason the gh-pages branch will always only have a single commit.

Since we do not want PRs generating the documentation the script will only run on pushes and only on the master branch. For this reason travis must be configured to build both pushes and pull requests.

Docs can be viewed at bignerdranch.github.io/CoreDataStack