Skip to content

docs(how-tos): add multiple version bootstrap guide#1152

Merged
mergify[bot] merged 1 commit into
python-wheel-build:mainfrom
rd4398:docs-multiple-version-bootstrap
May 13, 2026
Merged

docs(how-tos): add multiple version bootstrap guide#1152
mergify[bot] merged 1 commit into
python-wheel-build:mainfrom
rd4398:docs-multiple-version-bootstrap

Conversation

@rd4398
Copy link
Copy Markdown
Contributor

@rd4398 rd4398 commented May 13, 2026

Add a new how-to guide documenting the --multiple-versions flag for the bootstrap and bootstrap-parallel commands. Covers enabling the mode, how resolution and error handling work, flag interactions, and a complete example with verification steps.

Closes: #1110

@rd4398 rd4398 requested a review from a team as a code owner May 13, 2026 18:38
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 13, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: e0549e36-18ed-4693-849d-106bf8ee57a7

📥 Commits

Reviewing files that changed from the base of the PR and between 9fb5656 and 08ee4ba.

📒 Files selected for processing (2)
  • docs/how-tos/index.rst
  • docs/how-tos/multiple-version-bootstrap.rst
✅ Files skipped from review due to trivial changes (2)
  • docs/how-tos/index.rst
  • docs/how-tos/multiple-version-bootstrap.rst

📝 Walkthrough

Walkthrough

This PR adds documentation for the --multiple-versions feature. A new how-to guide (multiple-version-bootstrap.rst) explains how the flag changes resolution and build behavior to include all matching package versions rather than only the highest, distinguishes it from --skip-constraints, describes usage scenarios, covers configuration methods (CLI and requirements files), outlines operational steps, documents expected outputs, and documents interactions with other flags. An index entry in docs/how-tos/index.rst registers the new documentation under "Build Configuration" for discoverability.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: adding a new how-to guide for the multiple-version bootstrap feature.
Description check ✅ Passed The description is directly related to the changeset, explaining what guide was added and what it covers, with reference to the closing issue.
Linked Issues check ✅ Passed The PR fully addresses both objectives from issue #1110: documenting how to enable multiple-version bootstrap mode and how it works, with comprehensive coverage in the new guide.
Out of Scope Changes check ✅ Passed All changes are scoped to documentation updates directly related to the linked issue requirements, with no extraneous modifications.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@rd4398 rd4398 requested review from EmilienM and dhellmann May 13, 2026 18:38
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
docs/how-tos/index.rst (1)

50-50: ⚡ Quick win

Add a Sphinx change directive for this user-facing index update.

The new guide entry is user-facing; add a nearby .. versionchanged:: (or .. versionadded::) note to keep docs change history consistent.

As per coding guidelines, "**/*.{rst,py}: Use Sphinx versionadded, versionremoved, versionchanged directives for user-facing changes".

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/how-tos/index.rst` at line 50, Add a Sphinx version directive next to
the new entry "multiple-version-bootstrap": insert a nearby ".. versionadded::
<version>" (or ".. versionchanged:: <version>") directive directly above or
below the "multiple-version-bootstrap" line with a short one-line description of
the user-facing change, using proper RST indentation and blank-line separation
so the directive is associated with that entry.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/how-tos/multiple-version-bootstrap.rst`:
- Around line 41-44: Shell will interpret the requirement specifier in the
examples as redirection; update the two examples that call "fromager bootstrap
--multiple-versions requests>=2.28" and "fromager bootstrap-parallel
--multiple-versions requests>=2.28" to wrap the requirement specifier in quotes
(e.g. "requests>=2.28") so the shell treats it as a single argument rather than
performing output redirection.

---

Nitpick comments:
In `@docs/how-tos/index.rst`:
- Line 50: Add a Sphinx version directive next to the new entry
"multiple-version-bootstrap": insert a nearby ".. versionadded:: <version>" (or
".. versionchanged:: <version>") directive directly above or below the
"multiple-version-bootstrap" line with a short one-line description of the
user-facing change, using proper RST indentation and blank-line separation so
the directive is associated with that entry.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: ddda7291-d77d-40b6-a9ab-6809e88e98c7

📥 Commits

Reviewing files that changed from the base of the PR and between 2132ef3 and 9fb5656.

📒 Files selected for processing (2)
  • docs/how-tos/index.rst
  • docs/how-tos/multiple-version-bootstrap.rst

Comment thread docs/how-tos/multiple-version-bootstrap.rst Outdated
@rd4398 rd4398 force-pushed the docs-multiple-version-bootstrap branch from 0aa5a7e to e9ed2d0 Compare May 13, 2026 18:44
Comment thread docs/how-tos/multiple-version-bootstrap.rst Outdated
@rd4398 rd4398 force-pushed the docs-multiple-version-bootstrap branch from eeb5434 to 8e9aad3 Compare May 13, 2026 19:17
@rd4398
Copy link
Copy Markdown
Contributor Author

rd4398 commented May 13, 2026

@mergify rebase

Add a new how-to guide documenting the `--multiple-versions` flag for
the `bootstrap` and `bootstrap-parallel` commands. Covers enabling
the mode, how resolution and error handling work, flag interactions,
and a complete example with verification steps.

Co-Authored-By: Claude <claude@anthropic.com>
Signed-off-by: Rohan Devasthale <rdevasth@redhat.com>
@mergify
Copy link
Copy Markdown
Contributor

mergify Bot commented May 13, 2026

Deprecation notice: This pull request comes from a fork and was rebased using bot_account impersonation. This capability will be removed on July 1, 2026. After this date, the rebase action will no longer be able to rebase fork pull requests with this configuration. Please switch to the update action/command to ensure compatibility going forward.

@rd4398 rd4398 force-pushed the docs-multiple-version-bootstrap branch from 8e9aad3 to 08ee4ba Compare May 13, 2026 19:53
@mergify
Copy link
Copy Markdown
Contributor

mergify Bot commented May 13, 2026

rebase

✅ Branch has been successfully rebased

@mergify mergify Bot merged commit 03cd1a9 into python-wheel-build:main May 13, 2026
39 checks passed
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.

Document multiple version bootstrap

2 participants