tutor-indigo icon indicating copy to clipboard operation
tutor-indigo copied to clipboard

Resolving indigo templates breaking due to changes in upstream with automated github flows

Open HammadYousaf01 opened this issue 9 months ago • 1 comments

We’re facing problems where updates made to Open edX templates can occasionally break things in Tutor Indigo. We usually have to fix these issues manually, and they sometimes go unnoticed until someone points them out. One possible solution can be to automate this using Github actions like this

  • Every week, a GitHub Actions workflow will automatically run on a fixed schedule
  • perform a sparse checkout from the upstream Open edX repo, pulling only the specific templates
  • If there are new changes, the job then applies our customizations on top of the freshly pulled templates.
  • If any merge conflicts pop up, we raise a flag for manual review

I'm not quite sure about the actual feasibility of this approach.

HammadYousaf01 avatar Mar 25 '25 00:03 HammadYousaf01

A better solution, in my opinion, would be to merge Indigo directly into openedx repositories. That way, breaking changes would be immediately noticed by repository maintainers, if not (even better) by unit tests. This would also greatly simplify Open edX & Tutor in general and allow us to deprecate the little-used "default Open edX" theme.

kdmccormick avatar Apr 10 '25 00:04 kdmccormick