How To Release

Building a release

  • check whether docs are up to date

    • build docs as described at Static Documentation
    • disable incomplete docs
    • compress it as “site.zip”
  • check whether the code is clean

    • The methods should be documented
    • TODOs / “!!!” should be removed — maybe formulating them as github-Issues is an option
    • formatting should be updated
  • build release zips

    • Export UrMoAC to a jar with included or adjacent libraries it uses
  • build the release on github

    • the tag should be the current semantic version (<VERSION>)
    • the name should be “UrMoAC-<VERSION>
    • add some notes about what has been changed (see below)
    • add the compressed docs to the release

Contents of the release description

  • short note / welcome
  • ChangeLog
  • Information about using the documentation
  • greetings