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 #689

Open
praveenrewar opened this issue Sep 27, 2023 · 4 comments
Open

Update Go Module Names for Migrated Repositories #689

praveenrewar opened this issue Sep 27, 2023 · 4 comments
Labels
carvel accepted This issue should be considered for future work and that the triage process has been completed enhancement This issue is a feature request

Comments

@praveenrewar
Copy link
Member

Context

  • We've moved our git repos from the vmware-tanzu org to the carvel-dev 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.

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/carvel-dev/${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

@praveenrewar praveenrewar added enhancement This issue is a feature request carvel-triage labels Sep 27, 2023
@joaopapereira
Copy link
Member

Creation of the vanity URLs for this task is done in the PR #695

@joaopapereira
Copy link
Member

Created PR in ytt carvel-dev/ytt#878

@joaopapereira
Copy link
Member

Created PR on imgpkg carvel-dev/imgpkg#597

Copy link

This issue is being marked as stale due to a long period of inactivity and will be closed in 5 days if there is no response.

@github-actions github-actions bot added the stale This issue has had no activity for a while and will be closed soon label Nov 30, 2023
@joaopapereira joaopapereira added carvel accepted This issue should be considered for future work and that the triage process has been completed and removed stale This issue has had no activity for a while and will be closed soon carvel-triage labels Nov 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
carvel accepted This issue should be considered for future work and that the triage process has been completed enhancement This issue is a feature request
Projects
Status: No status
Development

No branches or pull requests

2 participants