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

Add docs showing pip-tools usage on dependencies #9158

Merged
merged 3 commits into from
May 3, 2022
Merged

Conversation

ericholscher
Copy link
Member

This will help users not have random jinja or docutils updates break their builds.

Fixes #9039

This will help users not have random jinja or docutils updates break their builds.

Fixes #9039
@ericholscher ericholscher requested a review from a team as a code owner May 2, 2022 22:12
Copy link
Contributor

@agjohnson agjohnson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's probably also worth noting to users that there is specific tooling that does this job much better, like Poetry and friends with lock files. Our suggestion is just the easiest to migrate to.

docs/user/guides/reproducible-builds.rst Outdated Show resolved Hide resolved
docs/user/guides/reproducible-builds.rst Outdated Show resolved Hide resolved
docs/user/guides/reproducible-builds.rst Outdated Show resolved Hide resolved
docs/user/guides/reproducible-builds.rst Outdated Show resolved Hide resolved
docs/user/guides/reproducible-builds.rst Outdated Show resolved Hide resolved
Comment on lines 162 to 164
.. code-block:: yaml

# File: docs/environment.yaml
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also :caption: here as well.

Copy link
Member

@humitos humitos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a good recommendation, I'm 👍🏼 on merging it.

However, I think the "Pinning transitive dependencies" section that you are adding is very similar to the previous one "Pinning dependencies" that does not pin transitive dependencies. So, I'd say that we should either:

  • refer to the previous section communicating that pinning all the versions, including transitive dependencies is better than the previous section but it implies an extra step
  • merge the two sections into one and only recommend pinning with pip-tools

Besides, this new section does not have a " Bad" subsection as the other have.

ericholscher and others added 2 commits May 3, 2022 11:14
Co-authored-by: Anthony <aj@ohess.org>
@ericholscher
Copy link
Member Author

ericholscher commented May 3, 2022

Yea, there's definitely some additional things to work on here, this is just a basic start that gets the info to our users when we link to this page. I agree that the previous section covers this, which I refer to in the first sentence.

@ericholscher ericholscher enabled auto-merge (squash) May 3, 2022 18:18
@ericholscher ericholscher disabled auto-merge May 3, 2022 21:41
@ericholscher ericholscher merged commit b6de82d into main May 3, 2022
@ericholscher ericholscher deleted the pip-tools-docs branch May 3, 2022 21:41
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

Successfully merging this pull request may close these issues.

Update Reproducible Builds docs with pip-tools
3 participants