Ensure that our org uses shared workflows from openedx, not edx
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 4
- Forks
- 33
- Avg merge
- 3d 54m
- Merged PRs (30d)
- 2
Description
Context
- This .github repo was copied from https://github.com/edx/.github
- Shared workflows (in
./.github/workflows) exist in both this repo and in the edx version of this repo. - Our repositories should reference the openedx version of the shared workflows, but we still reference the edx version of the workflow in many places: https://github.com/search?q=%22edx%2F.github%2F.github%2Fworkflows%2Fcommitlint%22+org%3Aopenedx&type=code
- A lot of progress was made over here: https://github.com/openedx/.github/issues/2. This ticket is follow-up.
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
openedxorganization, not theedxorganization.
- Ensure that any and all shared workflow references point to the
- For every GitHub Action workflow in the repo:
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, returnedTrue; - in the
check(...)method, searched for the substring"uses: edx/"within all YAML files in the.githubdirectory; - in the
fix(...)method, opened a PR to replace"uses: edx/"with"uses: openedx/".
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- 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