openedx / openedx/.github

Ensure that our org uses shared workflows from openedx, not edx

Open
#32 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
4
Forks
33
Avg merge
3d 54m
Merged PRs (30d)
2

Description

Context

Acceptance Criteria

  • For every repo in the openedx org:
    • For every GitHub Action workflow in the repo:
      • Ensure that any and all shared workflow references point to the openedx organization, not the edx organization.
Examples

What we want: https://github.com/openedx/acid-block/blob/1f76d2860013cb2e046bb1659c5c74b76775b50c/.github/workflows/commitlint.yml#L10

What we don't want: https://github.com/openedx/api-doc-tools/blob/81edb71fd132a66280be3af822c88e224bfb4f83/.github/workflows/commitlint.yml#L10

Notes

GitHub search can be used to find offending examples, e.g.: https://github.com/search?q=%22edx%2F.github%2F.github%2Fworkflows%2Fcommitlint%22+org%3Aopenedx&type=code

If we want to automate this, we could use @feanil 's new repo checks framework. Specifically, we add a Check subclass that:

  • in the is_relevant(...) method, returned True;
  • in the check(...) method, searched for the substring "uses: edx/" within all YAML files in the .github directory;
  • in the fix(...) method, opened a PR to replace "uses: edx/" with "uses: openedx/".

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the GitHub code search linked in the issue and inspect .github/workflows files for uses: edx/ references. For an automated approach, read terraform-github/migrate/repo_checks.py and its Check methods; done means every workflow in every openedx repository references openedx shared workflows instead of edx.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd, devops
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.