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

docs: Add git package packing doc #4750

Merged
merged 1 commit into from
May 22, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/source/guides/build-options.rst
Original file line number Diff line number Diff line change
@@ -251,6 +251,17 @@ this behavior by setting the ``lock_packages`` field to ``false``:
requirements_txt: "requirements.txt"
lock_packages: false

When including Python packages from GitHub repositories, use the ``pack_git_packages`` option (it defaults to ``true``) to control whether these packages should be cloned and packaged during the build process. This is useful for dependencies that may not be available via standard PyPI sources or for ensuring consistency with specific versions (for example, tags and commits) of a dependency directly from a Git repository.

.. code-block:: yaml

python:
pack_git_packages: true # Enable packaging of Git-based packages
packages:
- "git+https://github.com/username/repository.git@abcdef1234567890abcdef1234567890abcdef12"

Note that ``lock_packages`` controls whether the versions of all dependencies, not just those from Git, are pinned at the time of building the Bento. Disabling ``pack_git_packages`` will also disable package locking (``lock_packages``) unless explicitly set.

Python wheels
"""""""""""""