Skip to content

fix(no-ticket): show the dependencies help for list deps - #546

Open
cloudsmith-iduffy wants to merge 3 commits into
masterfrom
iduffy/fix-list-deps-help
Open

cloudsmith-iduffy wants to merge 3 commits into
masterfrom
iduffy/fix-list-deps-help

Conversation

@cloudsmith-iduffy

Copy link
Copy Markdown
Collaborator

Description

cloudsmith list deps --help showed the help for the entitlements list. The list dependencies wrapper in list_.py used functools.wraps(entitlements.list_entitlements), so Click took the entitlements docstring. It now wraps dependencies.list_dependencies.

I also rewrote the list_dependencies docstring in plain English. It now says what the command lists: the direct dependencies of a package, from the package dependencies endpoint, with the type, name, version operator and version of each. cloudsmith deps --help uses the same docstring.

Before:

Usage: cloudsmith list deps [OPTIONS] OWNER/REPO/PACKAGE

  List entitlements for a repository.

  - OWNER/REPO: Specify the OWNER namespace (i.e. user or org), and the REPO
  name where you want to list entitlements for. All separated by a slash.

After:

Usage: cloudsmith list deps [OPTIONS] OWNER/REPO/PACKAGE

  List the direct dependencies of a package.

  The list does not include transitive dependencies. For each dependency, the
  list shows the type, the name, the version operator and the version.

  The list can be incomplete. Cloudsmith does not extract dependencies for all
  package formats. For those formats, the list is empty.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Refactoring
  • Other (please describe)

Additional Notes

I checked every other functools.wraps and __doc__ use under cli/commands (entitlements, quarantine, dependencies, upstream). They all point at the right function. A new test checks that list deps --help names dependencies.

🤖 Generated with Claude Code

The list dependencies command copied the docstring of the entitlements
list command. Its help showed the entitlements text. The command now
copies the docstring of list_dependencies. The docstring is in STE.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Copilot AI balanced review requested due to automatic review settings October 24, 2026 17:50

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

The focused fix matches the reported issue, includes regression coverage, and has no identified blocking issues.

No open issues 🎉

What changed in this PR

Fixes cloudsmith list deps --help to show dependency help instead of entitlement help, without changing dependency retrieval.

Changes:

  • Corrects the wrapper’s help source to list_dependencies.
  • Clarifies dependency help text and adds type annotations.
  • Adds a regression test and changelog entry.
File Description
cloudsmith_cli/​cli/​tests/​commands/​test_list.py Adds regression coverage for dependency help text.
cloudsmith_cli/​cli/​commands/​list_.py Corrects the wrapped function and annotates the wrapper.
cloudsmith_cli/​cli/​commands/​dependencies.py Clarifies the shared help text and adds parameter types.
CHANGELOG.md Documents the help correction.

Review effort: Balanced

@cloudsmith-iduffy
cloudsmith-iduffy marked this pull request as ready for review October 24, 2026 17:52
@cloudsmith-iduffy
cloudsmith-iduffy requested a review from a team as a code owner October 24, 2026 17:52
@cloudsmith-iduffy
cloudsmith-iduffy enabled auto-merge (squash) October 24, 2026 17:52
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@cloudsmith-iduffy

Copy link
Copy Markdown
Collaborator Author

@copilot resolve the merge conflicts on this branch.

…s-help

# Conflicts:
#	CHANGELOG.md

Co-authored-by: cloudsmith-iduffy <178375997+cloudsmith-iduffy@users.noreply.github.com>
auto-merge was automatically disabled October 29, 2026 11:04

Head branch was pushed to by a user without write access

Copilot AI commented Oct 29, 2026

Copy link
Copy Markdown
Contributor

@copilot resolve the merge conflicts on this branch.

Merged master and resolved the CHANGELOG.md conflict, retaining both entries. Merge commit: 2e69613.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

4 participants