Skip to content

Latest commit

 

History

History
102 lines (67 loc) · 2.95 KB

release_checklist.md

File metadata and controls

102 lines (67 loc) · 2.95 KB

Release checklist

New feature release

  • Update CHANGES.txt

  • Bump version number to 2.EVEN.0 in all these locations:

    • SDL_image.h: SDL_IMAGE_MAJOR_VERSION, SDL_IMAGE_MINOR_VERSION, SDL_IMAGE_PATCHLEVEL
    • configure.ac: MAJOR_VERSION_MACRO, MINOR_VERSION_MACRO, MICRO_VERSION_MACRO
    • CMakeLists.txt: MAJOR_VERSION, MINOR_VERSION, MICRO_VERSION
    • Makefile.os2: MAJOR_VERSION, MINOR_VERSION, MICRO_VERSION
    • version.rc: FILEVERSION, PRODUCTVERSION, FileVersion, ProductVersion
    • VisualC/Version.rc: FILEVERSION, PRODUCTVERSION, FileVersion, ProductVersion
    • Xcode/Info-Framework.plist: CFBundleShortVersionString, CFBundleVersion

  • Bump ABI version information

    • Xcode/SDL_image.xcodeproj/project.pbxproj: DYLIB_CURRENT_VERSION, DYLIB_COMPATIBILITY_VERSION
      • set first number in DYLIB_CURRENT_VERSION to (100 * minor) + 1
      • set second number in DYLIB_CURRENT_VERSION to 0
      • if backwards compatibility has been broken, increase DYLIB_COMPATIBILITY_VERSION (?)
    • CMakeLists.txt:
      • if backwards compatibility has been broken, increase DYLIB_COMPATIBILITY_VERSION (?)

  • Run ./test-versioning.sh to verify that everything is consistent

  • Regenerate configure

  • Do the release

New bugfix release

  • Check that no new API/ABI was added

    • If it was, do a new feature release (see above) instead

  • Bump version number from 2.Y.Z to 2.Y.(Z+1) (Y is even)

    • Same places as listed above

  • Bump ABI version information

    • Xcode/SDL_image.xcodeproj/project.pbxproj: DYLIB_CURRENT_VERSION, DYLIB_COMPATIBILITY_VERSION
      • set second number in DYLIB_CURRENT_VERSION to patchlevel

  • Run test/versioning.sh to verify that everything is consistent

  • Regenerate configure

  • Do the release

After a feature release

  • Create a branch like release-2.6.x

  • Bump version number to 2.ODD.0 for next development branch

    • Same places as listed above

  • Bump ABI version information

    • Same places as listed above
    • Assume that the next feature release will contain new API/ABI

  • Run test/versioning.sh to verify that everything is consistent

  • Add a new milestone for issues

New development prerelease

  • Bump version number from 2.Y.Z to 2.Y.(Z+1) (Y is odd)

    • Same places as listed above

  • Bump ABI version information

    • Xcode/SDL_image.xcodeproj/project.pbxproj: DYLIB_CURRENT_VERSION, DYLIB_COMPATIBILITY_VERSION
      • set first number in DYLIB_CURRENT_VERSION to (100 * minor) + patchlevel + 1
      • set second number in DYLIB_CURRENT_VERSION to 0
      • if backwards compatibility has been broken, increase DYLIB_COMPATIBILITY_VERSION (?)

  • Run test/versioning.sh to verify that everything is consistent

  • Regenerate configure

  • Do the release