Skip to content

Latest commit

 

History

History
72 lines (68 loc) · 2.57 KB

release-checklist.md

File metadata and controls

72 lines (68 loc) · 2.57 KB
Raw

OpenFL Release Checklist

  • Add release notes to CHANGELOG.md
    • Compare to previous tag on GitHub: https://github.com/openfl/openfl/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 openfl-haxelib and openfl-docs artifacts for tag from GitHub Actions
  • Submit .zip file to Haxelib with following command: 
     haxelib submit openfl-haxelib.zip
  • Create new release for tag on GitHub
    • Upload openfl-haxelib.zip and openfl-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/openfl/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 refs in .github/workflows/deploy.yml in openfl/api.openfl.org repo 
     - uses: actions/checkout@v4
   with:
     repository: openfl/openfl
     path: openfl
     ref: x.y.z
 
 - uses: actions/checkout@v4
   with:
     repository: openfl/lime
     path: lime
     ref: a.b.c
  • 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 Lime at the same time, announcement thread should be combined
    • After posting, go back and add link to thread GitHub release description, if needed

OpenFL JS

  • Update version in package.json (may be updated already)
  • Update openfl, lime, and swf repo tags in package.json 
     "lime": "github:openfl/lime#8.2.0",
"openfl-haxelib": "github:openfl/openfl#9.4.0",
"swf": "github:openfl/swf#3.2.0",
  • Delete node_modules and package-lock.json.
  • Run npm install.
    • On macOS, arch -x86_64 npm install may be required
  • Commit new package.json and package-lock.json
  • Tag release and push 
     git tag -s x.y.z -m "version x.y.z"
 git push origin x.y.z
  • Download openfl-npm artifact for tag from GitHub Actions
  • Submit _.tgz file to Haxelib with following command: sh npm publish openfl-npm.tgz