Release

Releases are handled via GitHub Workflows.

Releasing Milestone

• Assuming project is on version 0.0.1-SNAPSHOT and releasing 0.0.1-M1 make sure:
  • You have 0.0.1-M1 milestone
  • Issues in it are closed
• Go to actions and pick Release Milestone
• Execute it manually and give postfix M1
• What happens next is:
  • Project version is modified from 0.0.1-SNAPSHOT to 0.0.1-M1
  • Changes are committed and pushed to GitHub with branch 0.0.1-M1 and tag v0.0.1-M1
  • Fatjar is build on linux and uploaded as artifact as we only need one jar
  • Matrix build for os's are done for graal binaries are uploaded as artifacts
  • GitHub release is created
  • Artifacts for fatjar and os binaries uploaded
  • GitHub release is create as a draft so you need to release it manually

Release Notes

There are some optional steps for GitHub Release what comes for release content.

• GitHub Release body is translated via mustache template in .github/rlnotes.mustache.
• Related issues for milestone are added as list
• Optionally you can add headers and footers to body just by creating issues and tag those as particular milestone, automation/rlnotes-header and/or automation/rlnotes-footer and content from issue header and body will be added as is.
• For headers and footers you can for example add images into an issue an link those in a body which is helpful for adding i.e. screencasts

Need to Release Again?

Releasing again with a same milestone would fail so you need to:

• Delete GitHub release if it exists
• Delete release branch 0.0.1-M1
  • git push origin :0.0.1-M1
• Delete release tag v0.0.1-M1
  • git push origin :v0.0.1-M1
• Run release again