Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[CLI-2340] Remove .netrc support #2751

Merged
merged 14 commits into from
May 24, 2024
Merged

[CLI-2340] Remove .netrc support #2751

merged 14 commits into from
May 24, 2024

Conversation

sgagniere
Copy link
Member

@sgagniere sgagniere commented May 7, 2024 •
edited

Release Notes

Breaking Changes

  • Saved credentials will no longer be read from the .netrc file

New Features

  • PLACEHOLDER

Bug Fixes

  • PLACEHOLDER

Checklist

  • Leave this box unchecked if features are not yet available in production

What

.netrc support for saved credentials was deprecated a while ago. This PR removes it.

References

Test & Review

Manually tested config migration: ran a command w/ this version and checked that netrc_machine_name was replaced by machine_name in the config file.

@sgagniere sgagniere added the v4 label May 7, 2024
@brianstrauch
Copy link
Member

Saved credentials will no longer be read from the ".netrc" file on Unix systems

Let's explain that they'll be read from the configuration file or macOS keychain so users don't get worried the --save functionality isn't going away.

brianstrauch
brianstrauch reviewed May 7, 2024
View reviewed changes
go.mod
@@ -40,7 +40,6 @@ require (
github.com/confluentinc/ccloud-sdk-go-v2/stream-designer v0.3.0
github.com/confluentinc/confluent-kafka-go v1.9.3-RC3
github.com/confluentinc/go-editor v0.11.0
github.com/confluentinc/go-netrc v0.0.0-20220321173724-4d50f36ff450
Copy link
Member

Choose a reason for hiding this comment

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

Let's archive https://github.com/confluentinc/go-netrc after the v4 release?

pkg/keychain/keychain_darwin.go Outdated Show resolved Hide resolved
internal/login/command.go Outdated Show resolved Hide resolved
internal/login/command_test.go Outdated Show resolved Hide resolved
pkg/auth/login_credentials_manager_test.go Outdated Show resolved Hide resolved
pkg/keychain/keychain_darwin.go Outdated Show resolved Hide resolved
pkg/keychain/keychain_test.go Outdated Show resolved Hide resolved
@sgagniere sgagniere marked this pull request as ready for review May 10, 2024 23:28
@sgagniere sgagniere requested a review from a team as a code owner May 10, 2024 23:28
brianstrauch
brianstrauch reviewed May 13, 2024
View reviewed changes
pkg/config/context.go Outdated
@@ -27,6 +27,7 @@ type Context struct {
FeatureFlags *FeatureFlags `json:"feature_flags,omitempty"`

// Deprecated
NetrcMachineName string `json:"netrc_machine_name"`
Copy link
Member

Choose a reason for hiding this comment

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

What's the reason for keeping this?

Copy link
Member Author

Choose a reason for hiding this comment

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

So that I can read it in Load() and move it to the new machine_name field for users upgrading from 3.x. I believe we still use it for config credentials.

@brianstrauch
Copy link
Member

Saved credentials will no longer be read from the .netrc file on Unix systems

I think we had Windows support for this too... maybe we can drop the part about "Unix systems" just in case.

@sgagniere sgagniere merged commit 68e4691 into v4 May 24, 2024
2 checks passed
@sgagniere sgagniere deleted the cli-2340 branch May 24, 2024 20:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@brianstrauch brianstrauch brianstrauch approved these changes

Assignees
No one assigned
Labels
v4
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@sgagniere @brianstrauch