Skip to content

docs(changelog): note packaging extras removal in Unreleased - #433

Open
LeonSGP43 wants to merge 1 commit into
NVIDIA-NeMo:mainfrom
LeonSGP43:docs/changelog-extras-removal
Open

docs(changelog): note packaging extras removal in Unreleased#433
LeonSGP43 wants to merge 1 commit into
NVIDIA-NeMo:mainfrom
LeonSGP43:docs/changelog-extras-removal

Conversation

@LeonSGP43

@LeonSGP43 LeonSGP43 commented Aug 15, 2026

Copy link
Copy Markdown

What

Adds a bullet to the Unreleased Removed section noting that the packaging extras [server], [gpu], and [all] were dropped together with the deprecated Python server stack — only [cli] remains.

Why

The 0.1.0 release notes advertise pip install nemo-switchyard with extras [server], [cli], [gpu], [all]. On current main, [project.optional-dependencies] defines only cli. The Unreleased section documents the server-stack removal but omits the extras removal, so users following the 0.1.0 packaging note get nemo-switchyard does not provide the extra 'server' warnings with silently missing dependencies.

Verification

# main
$ grep -A2 'optional-dependencies' pyproject.toml | grep -E '^(server|gpu|all|cli) =' 
cli = [
# v0.1.0 tag
$ gh api 'repos/NVIDIA-NeMo/Switchyard/contents/pyproject.toml?ref=v0.1.0' --jq .content | base64 -d | grep -E '^(server|gpu|all) ='
server = [

Signed-off-by: LeonSGP43 LeonSGP43@users.noreply.github.com

Summary by CodeRabbit

  • Documentation
    • Updated packaging documentation to reflect that only the CLI extra remains.
    • Documented installation of server functionality through the standalone switchyard-server binary.

The 0.1.0 release notes advertise 'pip install nemo-switchyard with
optional extras [server], [cli], [gpu], [all]'. The deprecated Python
server stack removal also dropped the [server], [gpu], and [all]
extras from pyproject.toml (only [cli] remains), but the Unreleased
Removed section does not mention it. Users following the 0.1.0
packaging note after upgrading hit 'does not provide the extra'
warnings. Document the removal.

Verified: pyproject.toml [project.optional-dependencies] on main
contains only 'cli'; the v0.1.0 tag contained server (and gpu/all).

Signed-off-by: LeonSGP43 <LeonSGP43@users.noreply.github.com>
@LeonSGP43
LeonSGP43 requested a review from a team as a code owner August 15, 2026 04:37
@coderabbitai

coderabbitai Bot commented Aug 15, 2026

Copy link
Copy Markdown

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: Enterprise

Run ID: c0729112-c72c-4a8c-aaf9-997c0859d3cf

📥 Commits

Reviewing files that changed from the base of the PR and between 9ad6744 and acad01e.

📒 Files selected for processing (1)
  • CHANGELOG.md

Walkthrough

The changelog documents removal of the [server], [gpu], and [all] packaging extras. It directs users to install server functionality through the standalone switchyard-server binary.

Changes

Packaging documentation

Layer / File(s) Summary
Document packaging extra removal
CHANGELOG.md
The changelog records removal of the [server], [gpu], and [all] extras and identifies [cli] as the remaining extra. It directs users to the standalone switchyard-server binary.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to acad0

This is a localized changelog-only documentation change, and no actionable merge-blocking risk remains beyond normal checks and review.

Poem

I’m a rabbit with a changelog neat,
Three extras hop away on fleet feet.
[cli] stays in the burrow bright,
switchyard-server guides the night.
Documentation now grows clear—
No packaging carrots disappear!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the Unreleased changelog entry documenting packaging extras removal.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

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.

1 participant