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

Update OEP-18 Python Dependency Management with more constraint tips #332

Open
robrap opened this issue May 27, 2022 · 8 comments
Open

Update OEP-18 Python Dependency Management with more constraint tips #332

robrap opened this issue May 27, 2022 · 8 comments
Labels
help wanted Ready to be picked up by anyone in the community

Comments

@robrap
Copy link
Contributor

robrap commented May 27, 2022

In order to help with unpinning pinned constraints, we would like to propose the following updates when pinning constraints:

  1. Include the pinning date in the comment for the pin. This will make it simpler to know how out-of-date we are.
  2. Create a github issue for unpinning the constraint.
@robrap robrap added arch-bom backlog Item is on a team's backlog or wish list. and removed arch-bom labels Jun 6, 2022
@robrap robrap moved this to Todo in Arch-BOM Jun 6, 2022
@robrap robrap added this to Arch-BOM Jun 6, 2022
@robrap robrap removed the backlog Item is on a team's backlog or wish list. label Apr 20, 2023
@sarina
Copy link
Contributor

sarina commented May 17, 2024

@robrap @feanil could you weigh in on whether this would be a helpful idea?

@sarina sarina added the waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. label May 17, 2024
@robrap
Copy link
Contributor Author

robrap commented May 17, 2024

I believe this would be helpful, and should be relatively simple. I captured it as an issue, rather than opening a PR, because I just didn't have the time to deal with the edits and see it through.

@sarina
Copy link
Contributor

sarina commented May 20, 2024

Makes sense, thanks. I'd like to see what @feanil and/or other members of Maintainers WG feels about this - I don't think I'm the best person to propose this change, as I am not deeply maintaining code repos, but I can help this process move forward if the Maintainers WG wants to push it forward.

@kdmccormick
Copy link
Member

Big +1 to the GitHub issue idea. Constraints are always a problem during upgrades, so having documentation and accountability for any constraint seems like a solid best practice.

My instinct would be to put the date in the GitHub issue rather than the comment, but that's not a strongly-held opinion. I'd support the change either way.

@feanil
Copy link
Contributor

feanil commented May 23, 2024

I agree that it would be useful to have a github issue for any new constraint that gets added. I think I could take or leave aspirational dates but the details about why the constraint was needed are super valuable.

@robrap
Copy link
Contributor Author

robrap commented May 23, 2024

My instinct would be to put the date in the GitHub issue rather than the comment, but that's not a strongly-held opinion. I'd support the change either way.

My thinking on the dates was simply that when looking over the constraints files, seeing that a constraint was added 5 years ago might stand-out and might get some action. Git blame is more for when you know what you are looking for, and dates on issues requires click-through. Anyway - just a thought.

I think I could take or leave aspirational dates

There should be nothing aspirational about the date. It is simply the date on which the constraint was pinned/added.

@sarina
Copy link
Contributor

sarina commented May 23, 2024

With three votes, but from people who've thought about this a lot, I think this is a good recommendation to move forward with.

@feanil I agree with Robert there's nothing in the issue description about an aspirational date of removal. This is just about documenting when the constraint was added, by both a comment and an associated GitHub issue.

I'm marking this as the Help Wanted label for anyone in the community to pick up, but I will try to draw down open issues as well over the next months.

@sarina sarina added help wanted Ready to be picked up by anyone in the community and removed waiting on author PR author needs to resolve review requests, answer questions, fix tests, etc. labels May 23, 2024
@robrap
Copy link
Contributor Author

robrap commented May 23, 2024

Note that equally important to documenting this would be putting it into practice in edx-platform and the common constraints file. We could chip away at this, but it might help to make issues for these two repos.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Ready to be picked up by anyone in the community
Projects
None yet
Development

No branches or pull requests

4 participants