Skip to content
Merged
Show file tree
Hide file tree
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
42 changes: 7 additions & 35 deletions docs/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ resolver_dist:
include_wheels: true
include_sdists: false
git_options:
submodules: true # Clone all submodules for git+https:// URLs
submodules: true # Clone all submodules for git-based source providers
build_dir: directory name relative to sdist directory, defaults to an empty string, which means to use the sdist directory
env:
USE_FFMPEG: "0"
Expand Down Expand Up @@ -103,10 +103,10 @@ the package. Templating is not supported here.

### Git submodules

When building packages from git repositories using `git+https://` URLs in your
requirements, you can configure git submodule handling using the `git_options`
settings. This is useful for packages that depend on external libraries included
as git submodules.
When using a git-based source provider (e.g. `pypi-git`, `github-tag-git`),
you can configure git submodule handling using the `git_options` settings.
This is useful for packages that depend on external libraries included as
git submodules.

#### Enabling all submodules

Expand Down Expand Up @@ -147,25 +147,6 @@ git_options:
- "vendor/lib2"
```

Git submodules are supported for packages specified as `git+https://` URLs in
bootstrap requirements, such as:

```text
my-package @ git+https://github.com/example/repo.git@v1.2.3
```

Example requirements file with Git URLs:

```{literalinclude} example/requirements-git-example.txt
:caption: requirements-git-example.txt
```

A complete package configuration example:

```{literalinclude} example/git-submodules-example.yaml
:caption: git-submodules-example.yaml
```

### Build directory

A `build_dir` field can also be defined to indicate to fromager where the
Expand Down Expand Up @@ -262,16 +243,8 @@ dependency hooks (`get_build_backend_dependencies`,
`get_build_sdist_dependencies`, etc.) that run *after* version
resolution.

It is **not** available:

- During the `resolve` phase itself — the version has not yet been
determined.
- When bootstrapping from a **git URL whose reference is not a valid
PEP 440 version** (for example
`pkg @ git+https://host/repo.git` or
`pkg @ git+https://host/repo.git@main`). In this case fromager
must build the package metadata just to discover the version, so
the early dependency-resolution hooks run with `version=None`.
It is **not** available during the `resolve` phase itself — the
version has not yet been determined.
Comment thread
rd4398 marked this conversation as resolved.

If your env var is used in a phase where the version might be
unknown, add a fallback default so the substitution does not fail:
Expand Down Expand Up @@ -563,7 +536,6 @@ def mycommand(
**How-To Guides:**

- [Override pyproject.toml](how-tos/pyproject-overrides.rst) - Modify build configuration
- [Build from Git](how-tos/build-from-git-repo.rst) - Use custom source repositories
- [Multiple Versions](how-tos/multiple-versions.rst) - Handle version conflicts

**Concepts:**
Expand Down
21 changes: 0 additions & 21 deletions docs/example/git-submodules-example.yaml

This file was deleted.

15 changes: 0 additions & 15 deletions docs/example/requirements-git-example.txt

This file was deleted.

55 changes: 0 additions & 55 deletions docs/how-tos/build-from-git-repo.rst

This file was deleted.

1 change: 0 additions & 1 deletion docs/how-tos/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ Guides for building packages from various sources and configurations.
.. toctree::
:maxdepth: 1

build-from-git-repo
repeatable-builds
parallel
build-web-server
Expand Down
2 changes: 0 additions & 2 deletions e2e/ci_bootstrap_parallel_suite.sh
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,5 @@ init_suite "Bootstrap Parallel Test Suite" "bootstrap-parallel tests"
# Bootstrap parallel tests
test_section "bootstrap parallel tests"
run_test "bootstrap_parallel"
run_test "bootstrap_parallel_git_url"
run_test "bootstrap_parallel_git_url_tag"

finish_suite
5 changes: 0 additions & 5 deletions e2e/ci_bootstrap_suite.sh
Original file line number Diff line number Diff line change
Expand Up @@ -44,9 +44,4 @@ run_test "bootstrap_cooldown_github"
run_test "bootstrap_cooldown_override"
run_test "bootstrap_cooldown_prebuilt"

test_section "bootstrap git URL tests"
run_test "bootstrap_git_url"
run_test "bootstrap_git_url_tag"
run_test "version_env_git_url"

finish_suite
1 change: 0 additions & 1 deletion e2e/ci_build_suite.sh
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,5 @@ run_test "build_steps"

test_section "advanced build tests"
run_test "build_parallel"
run_test "build_sequence_git_url"

finish_suite
59 changes: 0 additions & 59 deletions e2e/test_bootstrap_git_url.sh

This file was deleted.

59 changes: 0 additions & 59 deletions e2e/test_bootstrap_git_url_tag.sh

This file was deleted.

59 changes: 0 additions & 59 deletions e2e/test_bootstrap_parallel_git_url.sh

This file was deleted.

Loading
Loading