openedx / wg-build-test-release

Open edX Build / Test / Release Working Group
24 stars 14 forks source link

Include the list of tagged repositories somewhere #241

Closed kdmccormick closed 1 year ago

kdmccormick commented 1 year ago

@schenedx pointed out that it'd be great to have a list of released repositories available for anyone to see, every release.

We know there is a repo tools command to list out these repos, but it's not obvious or easy for any outside observer to set up and run this command.

schenedx commented 1 year ago

The list is at least generated now on Olive release page on openedx confluence. It would be great in new release notes to call out this list, and potentially the net changes to this list.

sambapete commented 1 year ago

According to what I found while looking at the edx and openedx org, the list might be incomplete.

I found the following repos were also tagged with olive.1 but not mentionned on Confluence edx/enterprise-access edx/frontend-app-learner-dashboard openedx/docs.openedx.org openedx/openedx-demo-course openedx/openedx-i18n openedx/openedx-test-course

They may not be part of the release, but they were tagged. Should they be mentioned?

arbrandes commented 1 year ago

@sambapete, you're right, I missed some. I had a mistake in the command I used to generate the list. Here's the diff of the updated version.

As we can see, though, openedx-i18n is not there. This is because it doesn't have either an openedx.yaml file or an open-release/olive.master branch. I have no clue why that is, if it's meant to be tagged. Looks like @regisb did the tagging manually.

Régis, can you help us understand how that repo is supposed to work in terms of release tagging?

regisb commented 1 year ago

This repo contains the i18n strings after they have been uploaded to transifex. Thus, it should not be tagged at the same time as other repos. Whenever a new minor release is made, I re-download, validate and compile the i18n strings. I then push the compiled strings to master and tag the commit. This commit is checked out in the openedx Docker image that ships with tutor (here).

With the upcoming openedx-translations repo (enacted by OEP 58 I expect that the openedx-i18n repo will become obsolete. Thus I suggest that we do nothing about it for now :)

arbrandes commented 1 year ago

Great, thanks for clearing that up!

arbrandes commented 1 year ago

Since it's in the Olive release tagging page, and since each release will have a different set of repos, I figure we can close this one.

kdmccormick commented 1 year ago

I added this step to the release tagging process: https://openedx.atlassian.net/wiki/spaces/COMM/pages/19662426/Process+to+Create+an+Open+edX+Release#2e.-Add-the-list-of-tagged-repositories-to-the-notes-page