Add more information to Release SOP Documentation

monarch-initiative / monarch-app

Monarch Initiative website and API

https://monarchinitiative.org/

BSD 3-Clause "New" or "Revised" License

18 stars 6 forks source link

Open sagehrke opened 10 months ago

sagehrke commented 10 months ago

We identified a few items to add to the Release Documentation https://monarch-initiative.github.io/monarch-documentation/release-process/ while trying to deploy to dev for January Release:

[ ] Add expected outputs for major steps so the person doing the release knows they are on the right track
[ ] Add who to ask for help if Kevin is not available and major items don't work, such as GCP issues and other items
[ ] Add step to remove dev/api-dev from load balancer before running provision

@glass-ships and @amc-corey-cox please add any other items you come across as you troubleshoot the release. Thank you!

FYI: @monicacecilia

monicacecilia commented 9 months ago

[ ] Testing: write/diagram details about testing workflow. Outline what is included in unit tests.
[ ] Testing: Regarding unit tests, check that the tests ask the right questions and that the answers are meaningful.
[ ] Testing: check UI functionality on "freeze" week; within the first 24 hours. For the February release, it's okay to list functions and manually test. In the long term, incorporate automated UI testing (e.g., Selenium).

sagehrke commented 9 months ago

Add a basic development and release process diagram for the SOP. On Slack, @kevinschaper said

that's a good idea! I think we'll be more of a line than a circle, or we'd be a circle for development process but a line for release process

Somethings like this (but add our own flair):

amc-corey-cox commented 9 months ago

[ ] #600 to document how to set up the repository for development and review PR's.

amc-corey-cox commented 9 months ago

Other work is ongoing in the #600 also mentioned above. We need to move this to the next milestone to keep improving.

monicacecilia commented 8 months ago

For next review, let's assess where we are with all the moving parts associated with this ticket. @amc-corey-cox 👀

monicacecilia commented 8 months ago

@monicacecilia -- create a few "surprise" tickets (or alternative) to remind us to check documentation with some frequency.