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

Update Go Module Names for Migrated Repositories #153

Closed
aaronshurley opened this issue Feb 20, 2021 · 3 comments
Closed

Update Go Module Names for Migrated Repositories #153

aaronshurley opened this issue Feb 20, 2021 · 3 comments

Comments

@aaronshurley
Copy link
Contributor

Context

  • We've moved our git repos from the k14s org to the vmware-tanzu org.
  • The module path of a project to match that of the GitHub repo where it lives.
  • ⚠️ We will rename the module names of all our tools; this is a breaking change for those who are depending on our tools as libraries/modules.

(mentioned in vmware-tanzu/carvel-kapp-controller#48.)


As a Developer using one or more Carvel tools as a module dependency
I want to know about the module rename ahead of time
And be clear about what I need to do to accommodate it
So that smoothly continue to enjoy using these tools instead of wasting time (and frustration) associated with discovering the source of a problem I didn't expect.


Acceptance Criteria

📘 Documentation

When I review the developer notes (e.g. docs/dev.md) for ${tool}
Then I see a note about the module rename.
And I'm more like to understand what changed.

__

📣 Advanced Notice

Given I'm on a team known to use ${tool} as a module dependency
When The module rename occurs
Then I am aware of it, shortly after it occurs
And I'm clear what I need to do to proactively accommodate the rename.

__

🌟 New Dependency

Given I am not yet using a Carvel tool as a module
When I name it as a new dependency in my project and use it

$ go get github.com/vmware-tanzu/carvel-${tool}

Then I successfully get that dependency (i.e. I see it in my go.mod)
And I can import packages from that module

__

🏚 → 🏠 Migrating/Upgrading

Given I am already using a Carvel tool as a module
When I follow the instructions "upgrade" to the next version (which contains the module rename)
Then I successfully get the new dependency (i.e. I see it updated in my go.mod)
And I can continue to import packages from that module in my own code

Resources

@ewrenn8
Copy link
Contributor

ewrenn8 commented May 18, 2021

@microwavables microwavables transferred this issue from carvel-dev/carvel-community Jul 12, 2021
@microwavables
Copy link
Contributor

Moved from /carvel-community to /carvel as we are merging the two repos to have /carvel be the main one

@praveenrewar
Copy link
Member

Closing this as this was completed. We are now moving to new vanity urls as part of #689

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants