release-checklist.md

Lime Release Checklist

• Add release notes to CHANGELOG.md
  • Compare to previous tag on GitHub: https://github.com/openfl/lime/compare/a.b.c...develop
  • Compare to previous tag in terminal:

     git log a.b.c...develop --oneline

  • Sometimes, commits from previous releases show up, but most should be correct
• Update release note in haxelib.json
• Update version in haxelib.json (may be updated already)
• Update release date in CHANGELOG.md
• Tag release and push

   git tag -s x.y.z -m "version x.y.z"
   git push origin x.y.z

• Download lime-haxelib and lime-docs artifacts for tag from GitHub Actions
• Submit .zip file to Haxelib with following command:

   haxelib submit lime-haxelib.zip

  • Lime releases are sometimes too large for Haxelib. If required, unzip and rezip with higher compresssion
    • First, unzip lime-haxelib.zip
    • Then, zip with highest compresssion (command for macOS terminal below):

       cd lime-haxelib/
       zip -r path/to/new/lime-haxelib.zip . -9

• Create new release for tag on GitHub
  • Upload lime-haxelib.zip and lime-docs.zip
  • Link to CHANGELOG.md from tag and to https://community.openfl.org announcement thread)
    • CHANGELOG.md tag URL format: https://github.com/openfl/lime/blob/x.y.z/CHANGELOG.md
    • It's okay to skip link to announcement at first, and edit the release to add it later
• Deploy API reference by updating Git ref in .github/workflows/deploy.yml in openfl/lime.openfl.org repo

   - uses: actions/checkout@v4
     with:
       repository: openfl/lime
       path: _lime-git
       ref: x.y.z

• Make announcement on https://community.openfl.org in Announcements category
  • For feature releases, it's good to write a summary of noteworthy new features
  • For bugfix releases, intro can be short
  • Include full list of changes from CHANGELOG.md
  • If also releasing OpenFL at the same time, announcement thread should be combined
  • After posting, go back and add link to thread GitHub release description, if needed