Skip to content

Latest commit

 

History

History
60 lines (46 loc) · 1.45 KB

release-checklist.md

File metadata and controls

60 lines (46 loc) · 1.45 KB

Generating sources

  • Regenerate source for vulkan and VulkanMemoryAllocator
    • Clean submodules and regenerate documentation first to ensure it's up to date.
  • If there are any changes commit those before proceeding

Versions

  • Bump version on vulkan in package.yaml

  • Bump version on VulkanMemoryAllocator

  • Bump version of vulkan dependency in VulkanMemoryAllocator

  • Run hpack in

    • .
    • ./VulkanMemoryAllocator

  • Make sure changelogs are up to date

    • ./changelog.md
    • ./VulkanMemoryAllocator/changelog.md

vulkan

  • Build documentation (So doc building for VMA works correctly)
    • cabal haddock --haddock-option="--hyperlinked-source"
  • Build documentation for Hackage
    • cabal haddock --haddock-for-hackage --haddock-option="--hyperlinked-source"
  • sdist
  • unpack sdist elsewhere
  • build sdl-triangle
    • Observe it running

VulkanMemoryAllocator

  • Build documentation
    • cabal haddock --haddock-for-hackage --haddock-option="--hyperlinked-source" VulkanMemoryAllocator
  • sdist
  • unpack sdist elsewhere
  • build

Tag git revision

  • git tag vXXX
  • git push --tags

gh-pages documentation

  • Run ./scripts/gen-standalone-haddocks.sh script pointing to a worktree on the gh-pages branch
    • Make sure to clean that directory first

(on my machine)

rm -rf ../vulkan-docs/*
nix-shell stack ghc
./scripts/gen-standalone-haddocks.sh ../vulkan-docs
cd ../vulkan-docs
git add .
git commit -m 'vXXX'
git push