Skip to content

Development

Notes

  • A new release every couple of weeks, if something meaningful happens
  • Semantic Versioning approach (MAJOR.MINOR.PATCH)
    • But none of the rules regarding compatibility apply as long as MAJOR version is 0
    • Expect breaking API changes, catch up using the Changelog
  • yourgame is based on yourgamelib, which is hosted here
  • ToDos are scattered in the code and docs. No dedicated list.

Release Checklist

Before Tag

  • Is YOURGAME_GIT_COMMIT_REQUESTED in CMakeLists.txt on yourgamelib's main branch?
  • Search for ToDo. Any quick fixes possible or already fixed?
  • Is the version correct in project() in CMakeLists.txt?
  • Is the version correct in Changelog?
  • Is the "Download here" link correct in Changelog?
  • Is the Changelog complete?
  • Remove (unreleased) from version in Changelog
  • Is the LICENSE file up to date? (dependencies provided by yourgamelib updated?)
  • Are the build artifacts (Actions) working?
  • Is the web demo working?

After Tag

  • Create release on GitHub and upload build artifacts
  • Set next version in project() in CMakeLists.txt
  • Add next version to Changelog with (unreleased)