Skip to content

RELEASE_CHECKLIST.md

Latest commit

 

History

History
37 lines (25 loc) · 2.12 KB

RELEASE_CHECKLIST.md

File metadata and controls

37 lines (25 loc) · 2.12 KB

Releasing

This document checklist of things that need to happen before, during, and after a release of this library. This document is included in the repo for a couple reasons:

  1. It makes it easier for people who are not the primary maintainers to perform a release if needed
  2. It helps one primary maintainer, who has the memory of a goldfish, remember to actually do all this stuff before releasing

Pre-flight checklist

Things to do before cutting a release:

  • Update the CHANGELOG with all relevant changes since the prior version. Easiest way to do this is to check the Next Release tag in Github.
  • Update the version in Configuration/Shared/Project-Version.xcconfig
  • Run the Documentation Generator as noted in api-reference.md to re-generate documentation from source for all included libraries
  • Validate that main builds with a test Swift Package Manager project
  • Validate that main builds with a test CocoaPods project
  • Validate that main builds with a test Carthage project (make sure to use --use-xcframeworks)
  • Make sure all playground pages merged into main run

Flight Plan

Things to do as part of releasing:

  • Add tag of format major.minor.patch to GitHub for SPM/Carthage
  • Run pod trunk push Apollo.podspec* to publish to CocoaPods
  • Update release on GitHub to have CHANGELOG contents for that version
  • Tweet link to tag for new version

* - You will need write permissions for this to actually work, please contact Ellen or Anthony if you need them and don't have them

Post-Flight Checklist

Things to do after release has been made:

  • Update version of library in sample applications (Currently: RocketReserver, and for changes to the ApolloCodegenLib, iOSCodegenTemplate)
  • Close out milestone in GitHub and all related issues
  • Create new "Next Release" milestone in GitHub
⚡