Skip to content

Release Checklist v1.1 WIP Do not use yet

Aaron D Borden edited this page Sep 13, 2016 · 9 revisions

Staging Checklist

Predeploy Activities

Scope and Quality Assurance

  • All PRs for this release have been reviewed and merged (open PRs for review).
  • All PRs for this release have been validated on dev.
  • 508 Accessibility review request has been filed here
  • Update code coverage water level for each repo [here](If we want to track our code coverage release-release)
  • Discussed any dependencies between data migration and code deployments (order, any outages, etc)
    • Develop plan for any downtime

Documentation

  • Write simplified release notes for FEC to review
  • Update repo documentation
  • FEC
  • fec-style
  • fec-cms
  • openFEC
  • openFEC-web-app
  • fec-eregs

Communication

  • Any communication that is needed from 18F FEC has been made

Deployment

  • Run migrations, code deployments as if this was a production deployment

Code

  • Release branches
  • fec-cms
  • openFEC
  • openFEC-web-app
  • fec-eregs
  • Dependency Versions
  • fec-style has been updated and published to npm
  • eregs dependencies have been validated

Data Migrations

  • SQL migrations
  • Legal data has been synced to stage
  • Wagtail migrations

Production Checklist

Versions / Tags to be Deployed / Picked up

This section is more for posterity.

  1. openFEC : Enter version/tag/branch or N/A
  2. openFEC-web-app : Enter version/tag/branch or N/A
  3. fec-cms : Enter version/tag/branch or N/A
  4. fec-style : Enter version/tag/branch or N/A
  5. fec-eregs : Enter version/tag/branch or N/A

Communication

  • If there is projected downtime, we have discussed the plan
  • Communicate release FEC is about to start
  • Communicate release has been completed to FEC

Additional Scope and Quality Assurance Pre Deploy

  • FEC has signed off on deploying to prod
  • 18F PMs have signed off on deploying to prod
  • All PRs direct to the release branch (label: Before Release) have been merged
  • Those Fixes have been validated on staging

Deployment

Order of Deployment

Order of Migrations

Change order if necessary

  • Data migrations
    • Run update scripts in standalone app if necessary
      • Allocate additional resources for the database to help with the processing before starting if need be.
  • Content migrations
  • Legal data has been sync'd to prod

Feature Flags

  • Legal feature flags have been enabled

Order of Deployment of Assets

Change order if necessary

  • Update fec-style and publish to npm as necessary
  • openFEC
    • Make sure local copies of master, develop, and release/[release name] branches are up-to-date.
    • Checkout the release/[release name] branch.
    • Run git flow release finish [release name]
    • Run git push --follow-tags
  • fec-cms
    • Make sure local copies of master, develop, and release/[release name] branches are up-to-date.
    • Checkout the release/[release name] branch.
    • Run git flow release finish [release name]
    • Run git push --follow-tags
  • openFEC-web-app
    • Make sure local copies of master, develop, and release/[release name] branches are up-to-date.
    • Checkout the release/[release name] branch.
    • Run git flow release finish [release name]
    • Run git push --follow-tags
    • Confirm that the new web app is up and running successfully.
  • fec-eregs

Post Deployment

  • Test the site
    • New features tested in prod
    • Critical sanity tested in prod
  • GitHub issues and PRs have been closed
  • GitHub milestones have been marked as complete