wg-build-test-release icon indicating copy to clipboard operation
wg-build-test-release copied to clipboard

Make the release process more repeatable

Open kdmccormick opened this issue 3 years ago • 12 comments

Existing process: https://openedx.atlassian.net/wiki/spaces/COMM/pages/19662426/Process+to+Create+an+Open+edX+Release#Make-a-release-or-release-candidate

Thing we found during the Nutmeg release that we want to be better next time:

  • All repos should be in openedx org
  • Remove/replace references to native installation
  • The entire release page should be numbered
  • have some way of remembering that we need to update things every release & point release

kdmccormick avatar Jun 09 '22 13:06 kdmccormick

  • The documentation steps that should have happened when nutmeg.master was made were never done.

nedbat avatar Jun 09 '22 13:06 nedbat

  • branch creation script didn't rollback changes when it crashed within do_the_work with a ReadTimeout

kdmccormick avatar Jun 09 '22 13:06 kdmccormick

  • we have too many release documentation pages (fyi @feanil )

kdmccormick avatar Jun 09 '22 13:06 kdmccormick

  • too many teams that sound like the "release" team: https://github.com/orgs/openedx/teams?query=release

kdmccormick avatar Jun 09 '22 13:06 kdmccormick

  • The week before the release:
    • check all the "maybe" repos
    • check that all the involved repos have permissions for community-release-managers

nedbat avatar Jun 09 '22 13:06 nedbat

  • need a step for "last-minute" repos that are added to release, including
    • add it to the release team
    • edit openedx.yaml
    • create the nutmeg.master branch
    • whether to create nutmeg.master from master, or back from the release cut date
    • ensure CI is passing

kdmccormick avatar Jun 09 '22 13:06 kdmccormick

  • would like to compare list of repos with access to the list of repos we're trying to create branches in (@regisb )

kdmccormick avatar Jun 09 '22 13:06 kdmccormick

  • wiki page should be update with new additions to tag_release tool, namely the save-the-repo-list-to-a-file feature.

kdmccormick avatar Jun 09 '22 15:06 kdmccormick

  • maintainers need to backport security fixes into release branches

kdmccormick avatar Jun 09 '22 15:06 kdmccormick

  • who's job is it to make the blog post?

kdmccormick avatar Jun 09 '22 15:06 kdmccormick

Need a way to check the permissions on all the repos at once. Perhaps a new tag_release option to make-then-delete a branch in each repo sequentially, showing the errors of the ones that fail.

nedbat avatar Jun 09 '22 15:06 nedbat

The Maple transifex resources are different than Lilac and before. The wiki page says to do it the Lilac way. We don't know who made the Maple resources, probably the translation working group. We need to coordinate and agree on the right approach.

nedbat avatar Jun 09 '22 16:06 nedbat

Just a ping for us to remember this ticket exists, and to do what we can during the Olive release.

arbrandes avatar Dec 06 '22 13:12 arbrandes

During Olive cutting earlier today:

  • Steps 4 and 5 were skipped, as it doesn't make sense to test the Native Installation anymore. And while we could use Tutor to do it, it was decided that because of the recent addition of the Community Test Plan and the corresponding tests, and because the Tutor images were rebuilt only a few hours later, we could skip the tests.

  • We no longer need to drop the release manager permissions.

arbrandes avatar Dec 12 '22 15:12 arbrandes

We've done what we can for Olive (@kdmccormick made changes to the release instructions), but there are still some wrinkles. Now bumping this to Palm, by which time we may consider closing it.

arbrandes avatar Dec 12 '22 16:12 arbrandes

For each problem listed here, either:

In general, anecdotally, it seems like the release process has become more repeatable since Nutmeg. @mtyaka has been able to transition into the role and lead releases without any major problems (as far as I know!)

Going to close this as a success 🎉 BTR, feel free to open a new issue for Palm+ if it seems necessary.

kdmccormick avatar Jun 14 '23 15:06 kdmccormick