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.

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

ec2imds: Module would be better placed in the feature/ec2/imds as higher level feature #943

Closed
jasdel opened this issue Dec 2, 2020 · 2 comments
Labels
breaking-change Issue requires a breaking change to remediate.

Comments

@jasdel
Copy link
Contributor

jasdel commented Dec 2, 2020

The ec2imds module at the root of the SDK is out of place with the rest of the SDK's design patter of putting service specific higher level features as a modules nested under the feature/ folder at the root of the SDK. The ec2imds module should be moved to feature/ec2/imds for consistence with rest of SDK's higher level features.

In order to help make this a smoother transition, and prevent future accidental discovery of the ec2imds module. The SDK should update this in two phase.

1.) Copy ec2imds module to feature/ec2/imds. Renaming the package, and updating all dependencies/codegen in the SDK. Delete the concepts of ec2imds module, and replace with empty module containing only doc.go file stating the package has been removed.

2.) After the release delete the ec2imds directory module from the SDK.

The purpose of this being a two phase process is to ensure references to the ec2imds module don't suggest the module is still valid, (e.g. https://pkg.go.dev/github.com/aws/aws-sdk-go-v2/ec2imds). Since pkg.go.dev will display docs for the latest version, even if that module has been deleted from the repo.

@jasdel jasdel added the breaking-change Issue requires a breaking change to remediate. label Dec 2, 2020
@jasdel jasdel added this to the v1.0 Release Candidate milestone Dec 2, 2020
@jasdel
Copy link
Contributor Author

jasdel commented Dec 17, 2020

This was fixed in, #984

@jasdel jasdel closed this as completed Dec 17, 2020
@github-actions
Copy link

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change Issue requires a breaking change to remediate.
Projects
None yet
Development

No branches or pull requests

1 participant