Skip to content

Conversation

euanh
Copy link
Collaborator

@euanh euanh commented May 1, 2025

Motivation

The --username and --password options define default values which are used if no suitable credentials can be found in .netrc. Their current names could imply that they override other sources of credentials - the help originally said this was the case (#123). Renaming them to --default-username and --default-password reduces the risk of misunderstanding.

Modifications

  • Rename the --user and --password options to --default-user and --default-password.
  • Add checks to warn that the old versions are deprecated, and fail if both are provided together.
  • Hide the old options from --help and remove them from the manual page
  • Rename the environment variable versions of these options. The environment variable change had not yet been released so deprecation warnings are not needed.

Result

  • New users will see more descriptive option names
  • Existing users will be prompted to change the options they pass

Test Plan

All existing test continue to pass.

@euanh euanh added area/documentation Improvements or additions to documentation semver/minor Adds new public API. labels May 1, 2025
@euanh euanh marked this pull request as ready for review May 1, 2025 11:39
@euanh euanh merged commit 49f92be into apple:main May 1, 2025
23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/documentation Improvements or additions to documentation semver/minor Adds new public API.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant