generate-lockfiles¶
Generate lockfiles for third-party dependencies.
Backend: pants.core
Config section: [generate-lockfiles]
Basic options¶
resolve¶
--generate-lockfiles-resolve="['<str>', '<str>', ...]"
PANTS_GENERATE_LOCKFILES_RESOLVE
default: []
Only generate lockfiles for the specified resolve(s).
Resolves are the logical names for the different lockfiles used in your project. For your own code's dependencies, these come from backend-specific configuration such as [python].resolves. For tool lockfiles, resolve names are the options scope for that tool such as black, pytest, and mypy-protobuf.
For example, you can run pants generate-lockfiles --resolve=black --resolve=pytest --resolve=data-science to only generate lockfiles for those two tools and your resolve named data-science.
If you specify an invalid resolve name, like 'fake', Pants will output all possible values.
If not specified, Pants will generate lockfiles for all resolves.
diff¶
--[no-]generate-lockfiles-diff
PANTS_GENERATE_LOCKFILES_DIFF
default: False
Print a summary of changed distributions after generating the lockfile.
diff_include_unchanged¶
--[no-]generate-lockfiles-diff-include-unchanged
PANTS_GENERATE_LOCKFILES_DIFF_INCLUDE_UNCHANGED
default: False
Include unchanged distributions in the diff summary output. Implies diff=true.
Advanced options¶
custom_command¶
--generate-lockfiles-custom-command=<str>
PANTS_GENERATE_LOCKFILES_CUSTOM_COMMAND
default: None
If set, lockfile headers will say to run this command to regenerate the lockfile, rather than running pants generate-lockfiles --resolve=<name> like normal.
Deprecated options¶
None