openedx / openedx/.github

Add workflow to validate dependencies against defined rules

Open
#93 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

Sparked by https://github.com/openedx/paragon/issues/2240

We have run into issues with edx specific packages being added as dependencies. The specific example mentioned in the Paragon issue was @edx/brand (as opposed to @edx/brand-openedx)

Ideally this would support both org-wide and repo-specific rules for package allow/block lists.

In order to address this across the entire org, it was decided that adding a workflow to this .github repository (and using repo_checks to ensure it's added to the appropriate repositories) would be the ideal path forward.

This has some overlap with https://github.com/openedx/edx-platform/issues/33189 which is probably also worth looking at for detecting python dependencies in the wrong org.

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 by reading the linked Paragon issue 2240 and edx-platform issue 33189, then inspect the existing repo_checks approach in this .github repository. Define how org-wide and repository-specific package allow/block rules should be represented and applied by the workflow. Done means the workflow validates dependencies and repo_checks can ensure it is added to the appropriate repositories.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.