Repository navigation
feat(ENG-15090): creating default credential helper dir in user's home directory - #482
Open
coillteoir wants to merge 2 commits into
Conversation
Contributor
There was a problem hiding this comment.
🟡 Changes recommended
The default breaks Terraform installation and leaves default-installed launchers behind during uninstall.
3 open findings
What changed in this PR
Adds a consistent credential-helper installation path and PATH guidance.
Changes:
- Defaults installations to
~/.cloudsmith/bin. - Centralizes Docker and Cargo PATH warnings with an export hint.
- Removes redundant test returns.
| File | Description |
|---|---|
cloudsmith_cli/credential_helpers/docker/installer.py |
Uses the shared PATH warning. |
cloudsmith_cli/credential_helpers/common.py |
Adds PATH warning generation. |
cloudsmith_cli/credential_helpers/cargo/installer.py |
Uses the shared PATH warning. |
cloudsmith_cli/cli/tests/test_org_option.py |
Removes a redundant return. |
cloudsmith_cli/cli/tests/test_decorators.py |
Removes redundant returns. |
cloudsmith_cli/cli/commands/credential_helper/manage.py |
Adds the default installation directory. |
🧠 Review effort: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Contributor
Author
Revision history
Generated by jj-stack from this pull request's force-push history. |
coillteoir
force-pushed
the
jj-stack/feat-eng-15090-adding-path-export-hint-on-credential-helper-install-rtlqvvxz
branch
6 times, most recently
from
October 14, 2026 15:22
711c9a0 to
71fb895
Compare
…e directory
If an install directory is not specified in the install command, the installer will fall back to the directory the CLI is installed in via which.
This causes issues when the CLI is installed via a package manager (brew, apt, nix), as credential helpers will be overwritten on package upgrade, or inaccessible in read-only packaging distributions.
- Adding default install path for credential helper at `~/.cloudsmith/bin/`
- Cloudsmith managed credential helpers should not interfere with directories managed by package managers.
- Default path for cloudsmith credential helpers means all cloudsmith related configs and software are under the same `.cloudsmith` directory.
- Adding hint to warning message to add install dir to path
- Adding a generic hint to add the credential helper to the path.
- Random lints via `ruff check --fix`
coillteoir
changed the title
coillteoir
force-pushed
the
jj-stack/feat-eng-15090-adding-path-export-hint-on-credential-helper-install-rtlqvvxz
branch
from
October 14, 2026 15:43
71fb895 to
918d086
Compare
This comment was marked as duplicate.
This comment was marked as duplicate.
Sorry, something went wrong.
| @click.option( | ||
| "--bin-dir", default=None, help="Directory to install the launcher binary." | ||
| "--bin-dir", | ||
| default=None, |
Collaborator
There was a problem hiding this comment.
Why not set the default here rather than on line 58?
cloudsmith-iduffy
approved these changes
Oct 14, 2026
cloudsmith-iduffy
left a comment
cloudsmith-iduffy
left a comment
Collaborator
There was a problem hiding this comment.
Small question on default placement but otherwise fine.
Usage for terraform is a little confusing but I don't see another way - maybe help text of terraform installer will ignore this option but its not useful to see that every time.
…-hint-on-credential-helper-install-rtlqvvxz
cloudsmith-iduffy
enabled auto-merge (squash)
October 14, 2026 23:14
cloudsmith-iduffy
disabled auto-merge
October 14, 2026 23:14
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
If an install directory is not specified in the install command, the installer will fall back to the directory the CLI is installed in via which. This causes issues when the CLI is installed via a package manager (brew, apt, nix), as credential helpers will be overwritten on package upgrade, or inaccessible in read-only packaging distributions.
~/.cloudsmith/bin/.cloudsmithdirectory.ruff check --fix