Skip to content

Latest commit

 

History

History
37 lines (36 loc) · 1.24 KB

release-checklist.md

File metadata and controls

37 lines (36 loc) · 1.24 KB

Starling Release Checklist

  • Add release notes to CHANGELOG.md
    • Compare to previous tag on GitHub: https://github.com/openfl/starling/compare/a.b.c...master
    • Compare to previous tag in terminal:
       git log a.b.c...master --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 version in package.json (may be updated already)
  • Update openfl version in package.json
      "openfl": "^9.4.1",
  • Delete node_modules and package-lock.json.
  • Run npm install.
    • On macOS, arch -x86_64 npm install may be required
  • 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 starling-haxelib, starling-npm.tgz, and starling-docs artifacts for tag from GitHub Actions
  • Submit .zip file to Haxelib with following command:
     haxelib submit starling-haxelib.zip
  • Submit .tgz file to npm with following command:
     npm publish starling-npm.tgz
  • Create new release for tag on GitHub
    • Upload starling-haxelib.zip, starling-npm.tgz, and starling-docs.zip