Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enforcement for ADR 14 #31865

Open
3 tasks
Tracked by #181
timmc-edx opened this issue Mar 1, 2023 · 0 comments
Open
3 tasks
Tracked by #181

Enforcement for ADR 14 #31865

timmc-edx opened this issue Mar 1, 2023 · 0 comments

Comments

@timmc-edx
Copy link
Contributor

ADR 14 is a decision to require justification for the addition of any new app to edx-platform. However, it has proven difficult to socialize this decision well enough that people abide by it; usually they find out once it's in production and Arch-BOM comes asking about it (having learned of the app via instrumentation). We could have those discussions much sooner if we add GitHub Actions to check for new apps.

Acceptance criteria:

  • GitHub Action that fails if a new Django app is added that does not contain an ADR (details in OEP-49 shortly)
    • Trigger on PRs
    • Detect whether new directories have been added under the known Django apps directories, and check them
  • GitHub Action failure has an informative message that points to the ADR (use a job summary)
  • Optional: Consider making a reusable action that can be pointed at any directory and that checks as much of OEP-49 as possible; then use that from edx-platform
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant