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

The banner in the generated requirements.txt is confusing #1636

Closed
jceresini opened this issue Jun 2, 2022 · 3 comments · Fixed by #1547
Closed

The banner in the generated requirements.txt is confusing #1636

jceresini opened this issue Jun 2, 2022 · 3 comments · Fixed by #1547
Labels
writer Related to results output writer component

Comments

@jceresini
Copy link

When I use pip-compile to generate a requirements.txt file, it includes this banner at the top:

# This file is autogenerated by pip-compile with python 3.8
# To update, run:
#
#    pip-compile --no-emit-index-url

However, without the --upgrade argument, that command won't generate a new requirements.txt file, unless the setup.py changes. It sounds like it's the distinction between updating the file vs upgrading the packages pinned in the file. As a new user, I found that confusing when subsequent runs of pip-compile weren't picking up upgraded packages.

Ref: https://github.com/jazzband/pip-tools/blob/master/README.rst?plain=1#L64-L68

@AndydeCleyre
Copy link
Contributor

Just adding a note: even if the setup.py doesn't change, the output file may be updated if dependency versions get revoked, or if the command is run on a different platform resulting in a different dep tree.

@atugushev
Copy link
Member

Agreed. Perhaps, there should be mentioned that a file is autogenerated by the command.

@atugushev atugushev added the writer Related to results output writer component label Aug 6, 2022
@CodePint
Copy link

CodePint commented Nov 10, 2022

just jumping on this to say; it would also be appreciated if the command was multiline

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
writer Related to results output writer component
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants