Skip to content
This repository has been archived by the owner on Dec 10, 2024. It is now read-only.

Migration Announcement: go-gitlab moves to GitLab.com #2060

Closed
timofurrer opened this issue Nov 15, 2024 · 3 comments
Closed

Migration Announcement: go-gitlab moves to GitLab.com #2060

timofurrer opened this issue Nov 15, 2024 · 3 comments
Assignees

Comments

@timofurrer
Copy link
Contributor

timofurrer commented Nov 15, 2024

🗣️ Migration Announcement: go-gitlab moves to GitLab.com

We're excited to announce that this Go package previously hosted at github.com/xanzy/go-gitlab
is moving to a new home at gitlab.com/gitlab-org/api/client-go! 🎉

-> When: soon, we'll provide an update in the coming days. 2024-12-10 at 14:00 UTC

What does this mean for you?

This migration will be straightforward:

  • To continue using the package, simply update your import path and
    go.mod reference from github.com/xanzy/go-gitlab to gitlab.com/gitlab-org/api/client-go.
  • No other breaking changes are expected.

Why the move?

This transition ensures better alignment with GitLab's ecosystem and simplifies maintenance.
If you are contributing to this package you are most likely a familiar GitLab user already.

The project remains open source with the same license and community-driven,
with ongoing contributions encouraged and welcomed.

Maintainers Update

Sander (@svanharmelen), the original author of the package, has stepped down and offered
GitLab contributors to maintain it.
We extend our heartfelt thanks to Sander for his amazing work in creating and maintaining this library! 🙏
Moving forward, Timo (@timofurrer) and Patrick (@RicePatrick) will continue maintaining
the project to ensure its stability and growth.

Next Steps

  • We'll update this issue with an exact date of the migration.
  • Feel free to share your feedback and suggestions here in the issue.

Thank you for being part of this journey!
We're looking forward to continuing the development of this library together with the vibrant Go and GitLab communities.

Happy coding! 🚀

- Timo

@timofurrer
Copy link
Contributor Author

Migration date: 2024-12-10 at 14:00 UTC

Quick Updates:

Important information:

  • If you want your issues, pull requests, comments etc. to be linked to your GitLab account, please make sure your e-mail addresses can be mapped. See https://docs.gitlab.com/ee/user/project/import/github.html#accounts-for-user-contribution-mapping
  • All contributions to this project during the migration will be "dangling on GitHub" - we'll make sure to let you know if this has happened and help to migrate the contribution over to GitLab.
  • This project will be archived once the migration is complete.
  • All old releases will still be available. Your project won't be broken because of this but you'll stop receiving updates.

@RicePatrick
Copy link
Contributor

Note - We will also be adding a deprecation notice on the NewClient function and on the module declaration that includes a notice of the migration.

During testing how best to communicate the migration of this module we examined using only the module deprecation pattern and noticed that the warning return is largely buried within the go get command, and users would only notice it if they were carefully examining the results of each line.

To ensure the migration is as visible as possible, we will therefore include a deprecation notice on the function as well. The deprecation will not be present on the migrated module, so only users still referencing the GitHub module path will have the deprecation on the function.

Hopefully this helps as many people migrate as possible!

@timofurrer
Copy link
Contributor Author

Successfully migrated: 2024-12-10 at 16:00 UTC

Migration

The migration itself should be a simple search and replace. Something along the lines of:

git grep github.com/xanzy/go-gitlab | cut -d: -f1 | sort | uniq | xargs -n1 sed -i 's#github.com/xanzy/go-gitlab#gitlab.com/gitlab-org/api/client-go#'
go mod tidy
go build

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

No branches or pull requests

3 participants