[Discovery] Improve common constraints experience
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
- Issue type
- Feature
- Clarity
- Needs clarification
- Activity status
- Stale
- Tech stack
- python
- Domain
- build-system, tooling
Research direction
Start by reading common_constraints.txt and constraints.txt, then compare the dependency guidance in base.in with the discussion linked from edx-lint#125 and the edx-lint#182 example. The work is complete when the process for overriding common constraints, marking those overrides, and cleaning them up is clearly defined.
Written by the indexing model from the issue text.
Description
Issue description and initial comments moved from private ticket: https://2u-internal.atlassian.net/browse/BOM-2721
The process around common_constraints.txt has some issues as we work through upgrades.
- It is not simple to override a common constraint in
constraints.txt, which is where you might expect to do this when working through an upgrade that isn't yet available globally. - It is not clear how to mark and clean-up overrides once the common constraints can finally be removed.
See https://github.com/edx/auth-backends/pull/125#discussion_r685288124 for some related discussion.
Additional Notes:
- Some related docs updates:
- Reminder: If we are making changes to a library based on a new or updated api in a dependency, we need to add and comment a new minimum requirement in
base.in. - If we know that a library will break with an updated dependency, we should add a maximum constraint in to the library’s
base.in, and not just rely oncommon_constraints.txt. - If we release an updated library that fixes and uses a newer version of a dependency that is in
common_constraints.txt, we either need to:- remove the dependency from
common_constraints.txt(if we are ready), or - add a maximum constraint to
common_constraints.txtfor the library update, so no one will try to pick up the new version of the library which will conflict with the active common constraint on the dependency.- See example: https://github.com/edx/edx-lint/pull/182
- remove the dependency from
- Reminder: If we are making changes to a library based on a new or updated api in a dependency, we need to add and comment a new minimum requirement in
- Dominant language
- Python
- Stars
- 52
- Forks
- 34
- Avg merge
- 2h 4m
- Merged PRs (30d)
- 4
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing 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.
More from openedx/edx-lint
-
Difficulty 1/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 48/100
openedx/edx-lint#520 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
Maintainers usually reply within 1 day
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
Maintainers usually reply within 1 day
All issues in openedx/edx-lint
Similar issues
-
CI flake: test-windows times out spawning Node in tests/test_antigravity_node_hooks.py (develop red)Openarea/ci P2
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 2 days
-
benchmark
Difficulty 1/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 79/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
mozilla-ai/cq#601 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
Maintainers usually reply within 1 day