Release.md

Creating an OPAL Release

Necessary Steps

1. integrate everything into the develop branch
2. run tests and integration tests
3. update Changes.md
4. migrate everything to the master branch
5. update version number in build.sbt
6. update version information in src/site/index.md
7. run tests and integration tests (to ensure that everything works without assertions)
8. publish to maven (sbt publishSigned)
9. upload the build (sbt sonatypeCentralUpload)
10. go to Sonatype to release the build
11. generate the webpage (sbt generateSite)
12. upload the new webpage to www.opal-project.de
13. upload the generated ScalaDoc to library/api/SNAPSHOT

Optional Steps

1. upload the latest version of the OPAL-Disassembler to artifacts
2. update MyOPALProject using the latest released version of OPAL
3. force the recreation of the OPAL Docker Container and publish it to DockerHub
4. update OPAL-Integration IntelliJ Plug-in
5. update OPAL-Explorer Visual Studio Code Plug-in

Preparing the next release

1. merge changes from master back to develop (in particular version information)
2. update version information (build.sbt) (x.y.z-SNAPSHOT)
3. release a new snapshot build to ensure that the snapshot is always younger than the last release (sbt publishSigned)