General Checklist

When the DarkMatter SDK code has been checked in, verified by QA and is ready to be deployed, please follow this checklist to ensure nothing is missed.

  • Determine a release version and put it in the DarkMatter::SDK_VERSION field
  • Update the DarkMatter Changelog
  • Make the SDK package according to the platform specific packaging instructions
  • Upload the SDK to Google Drive and put a link to it in the Documentation
  • Generate and upload the documentation to S3
    • If this release a patch version increase, delete the current documentation folder before uploading over it
    • If this release is anything above a patch version, create a new folder for the new documentation
    • Refer to the platform specific instructions below on generating documentation
  • Send out an email to Production and Scryptkeepers about the release

iOS Specific Instructions

Making the SDK Package

There is a script inside the code repository that will generate the SDK package. Please refer to the README file located in the DarkMatter/proj.ios directory, as well as the output from the darkmatter.sh help command.

Generating the Documentation

There is a script inside the code repository that will generate the SDK documentation. Please refer to the README file located in the DarkMatter/proj.ios directory, as well as the output from the darkmatter.sh help command.

Android Specific Instructions

Making the SDK Package

Compress the DarkMatter/proj.android/DarkMatter/DarkMatterLibrary folder. This zip file is the Android SDK package.

Generating the Documentation

The Android documentation is generated using Doxygen. Run the Doxywizard application and point the directory to run it in at DarkMatter/proj.android/docs. In there is a doxygen configuration file (a Doxyfile) that will tell Doxygen how to generate the documentation. Run doxygen from the wizard, which will output an html folder in the docs directory. The contents of this folder are what you upload to the S3 docs site.

Unity Specific Instructions

Making the SDK Package

The Unity SDK package contains a .unitypackage file exported from Unity. From the DarkMatter Unity project, export the entire Libraries folder, as well as the following files from the Plugins/Android folder:

  • darkmatterTemplate.gradle

Generating the Documentation

The Unity documentation is generated using Doxygen. Run the Doxywizard application and point the directory to run it in at DarkMatter/proj.unity/docs. In there is a doxygen configuration file (a Doxyfile) that will tell Doxygen how to generate the documentation. Run doxygen from the wizard, which will output an html folder in the docs directory. The contents of this folder are what you upload to the S3 docs site.