Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

There are two types of tagged releases:

  • the major release (zebrawood.1) and

  • the minor releases (zebrawood.2, zebrawood.3, and sometimes zebrawood.4+).

...

The steps below will apply to both types of major & minor releases, some will only apply to major releasesunless they say (major only).

1. Prepare for the tagging a week before it is scheduled….

1a. Schedule a release ceremony

...

Schedule a meeting for the day of release, including:

...

Go to the Test Plan spreadsheet and check whether testing has been sufficiently completed (to the discretion of the release manager).

1c. Double-check that all known issues have been addressed

...

Prior to making a release (major, minor, or even a candidate), it is imperative that all known issues be fixed. You can check at the GitHub Project board with an appropriate filter such as “label:bug milestone:lilac.1”. Over time other labels or milestones may be incorporated, but just keep in mind that issues such as an uninstallable tag are unacceptable.

Search for open pull requests against the release branch. For example, for Nutmeg, we would search: https://github.com/pulls?q=is%3Aopen+is%3Apr+base%3Aopen-release%2Fnutmeg.master+archived%3Afalse.

1d. Create a wiki pages for release process notes

...

Create a child of this page for your own notes: Open edX Release Manager Notes

...

2. Hold a release tagging ceremony

2a. Make a test branch (not a tag!

...

)

To test the installation, but not yet mark the release, we'll make a test branch.  The branch should use your personal prefix ("you/"), and be named for the release you are working on, but with an additional .n suffix.  Don't use the full release name, or people will find the branch and think it is a release:

...

2b. Update and upload translations on the test branch

Note

This step is out of date. The release manager hasn’t done this since Nutmeg or earlier. Instead:

  • For major releases: Reach out to #wg-translations and inform them that the <zebrawood>.1 has been tagged. Hopefully, someone will know what that means and help you out.

  • For major & minor releases:Régis B. has some particular steps he does with openedx-i18n as part of the Tutor release process.

This should all be replaced when OEP-58 is implemented.

For this method, you should be using tutor and should have openedx/edx-platform on the target release branch locally.

...

Code Block
tutor config save --set OPENEDX_COMMON_VERSION=you/test/z.1rc1.1
tutor images build --build-arg OPENEDX_I18N_VERSION=open-release/<y> openedx
tutor local launch

...