...

Update the pull request template in the master branch of edx/edx-platform to encourage developers to contribute bugfixes back to both the upcoming & next release branches (see for instance this PR).

🎁 Tagging a release or release candidate (Tagging Numbered Releases)

Releases are tags marking specific versions of all the repos.  Take care with the steps to create and tag these.  It's surprising, but you have to edit files to refer to the tags before you can create the tag.

There are two types of tagged releases:

• the major release (zebrawood.1) and

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

The steps below apply to both major & minor releases, unless 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:

• The release manager (you!)

• At least one other Build-Test-Release WG member to check your work, take notes, etc.

• If necessary, someone from Axim to grant permissions (see “Overview / Release Manager Permissions” section).

• Anyone else who wants to listen in!

Ask someone from Axim to put it on the community working groups calendar.

1b. Double-check that the test plan is complete (major only)

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

Example: Olive.1

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:

tag_release --doit --branch --skip-invalid --search-branch open-release/zebrawood.master --override-ref open-release/zebrawood.master you/test/z.1rc1.1

The .1 suffix is so that you can make a .2 if something needs to be fixed.

2b. Create the release Transifex project

2b1 Double check the openedx-translations repository branch

Go to the https://github.com/openedx/openedx-translations repository and ensure it has the proper release branch e.g. you/test/z.1.

2b2 Clone the openedx-translations Transifex project

After cutting the release e.g. zebrawood a new Transifex project should be copied into a new project.

• Create a new Transifex project: openedx-translations-zebrawood

• Copy the resources from the old project (How to do that without ?)

2b3 Configure the GitHub Transifex App

This is a manual step:

...

Go to the Zebrawood Transifex project configuration settings

...

In the Integrations tab, click on the GitHub App integration “Manage” button

...

Click on the three dots ... menu → the Settings button

Configure the project integrations settings from the main/master project (https://github.apps.transifex.com/projects/o:open-edx:p:openedx-translations/openedx/openedx-translations):

...

Select repo step:

• Selected repository: openedx/openedx-translations

• Selected branch: you/test/z.1 or open.release/zebrawood.master

...

Select files step:

• Add a path to your YAML configuration file: transifex.yml

...

Sync content step:

• PULL CONTENT: Fetch content automatically

• PUSH CONTENT: 100% reviewed

• How would you like Transifex to push translations to GitHub? Create a Pull Request and No grouping

• Add a prefix to the commit message: chore:

...

6. Create the release Transifex project

6a Double check the openedx-translations repository branch

Go to the https://github.com/openedx/openedx-translations repository and ensure it has the proper release branch e.g. you/test/z.1.

6b Clone the openedx-translations Transifex project

• Create a new Transifex project: openedx-translations-zebrawood.

• Add all the languages from the openex-translatiosn

6c Configure the GitHub Transifex App

This is a manual step:

• Go to the Zebrawood Transifex project configuration settings

• In the Integrations tab, click on the GitHub App integration “Manage” button

• Click on the three dots ... menu → the Settings button

• Configure the project integrations settings from the main/master project (https://github.apps.transifex.com/projects/o:open-edx:p:openedx-translations/openedx/openedx-translations ):

  • Select repo step:

    • Selected repository: openedx/openedx-translations

    • Selected branch: Set it to the release branch e.g. open.release/zebrawood.master

  • Select files step:

    • Add a path to your YAML configuration file: transifex.yml

  • Sync content step:

    • PULL CONTENT: Fetch content automatically

    • PUSH CONTENT: 100% reviewed

    • Set “How would you like Transifex to push translations to GitHub?” to Create a Pull Request and No grouping

    • Add a prefix to the commit message: chore:

  • Click on the Update Settings button

  • Wait for the sync to complete. It takes about an hour.

🎁 Tagging a release or release candidate (Tagging Numbered Releases)

Releases are tags marking specific versions of all the repos.  Take care with the steps to create and tag these.  It's surprising, but you have to edit files to refer to the tags before you can create the tag.

There are two types of tagged releases:

• the major release (zebrawood.1) and

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

The steps below apply to both major & minor releases, unless 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:

• The release manager (you!)

• At least one other Build-Test-Release WG member to check your work, take notes, etc.

• If necessary, someone from Axim to grant permissions (see “Overview / Release Manager Permissions” section).

• Anyone else who wants to listen in!

Ask someone from Axim to put it on the community working groups calendar.

1b. Double-check that the test plan is complete (major only)

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

Example: Olive.1

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:

tag_release --doit --branch --skip-invalid --search-branch open-release/zebrawood.master --override-ref open-release/zebrawood.master you/test/z.1rc1.1

The .1 suffix is so that you can make a .2 if something needs to be fixed.

2c. Test the release one last time

...