search

rackspace / gophercloud

A Go SDK for OpenStack. IN FEATURE FREEZE. See Issue #592
http://gophercloud.io
Other
456 stars 180 forks source link

FEATURE FREEZE (Users of this library should read this) #592

Open jrperritt opened 8 years ago

jrperritt commented 8 years ago

New features (read: features not currently pending in a PR) will no longer be added to this library. Over the next month (tentatively), the library will be migrated to gophercloud/gophercloud and the rackspace directory will be moved to its own, yet-to-be-made-public repository. Bug fixes will be reviewed and merged, and this repo will continue to exist, though (in a month or so) it should be considered deprecated.

Pending pull requests in this repository will go through the review process and, if suitable, will ultimately be merged before being migrated to the new one(s). Outstanding issues that do not have pull requests will be addressed in the new repo(s). The new repos were created with the git history of this repo and as such user contributions will, for the most part, be maintained.

Currently the gophercloud/gophercloud repo is not accepting pull requests for 2 reasons: 1) the API is not completely stable, and 2) the contributing guide needs to be updated. Contributing to the new repo(s) will be a bit more structured so as to try to make PRs easier to review and therefore easier to merge. When those 2 items are completed, this issue will be updated, and the repos will be open for PRs. Currently, issues may be created in gophercloud/gophercloud to discuss changes to the new API and feature requests.

The new repo(s) are almost entirely backwards-compatible with this one. Backwards-incompatible changes will be aggregated and enumerated here (in this issue's description).

This issue will exist to provide updates on the migrations (ie. when the APIs are stable, when users can start contributing PRs to the new libraries, ...)

mikesimons commented 8 years ago

Is this still on track? I see nothing in gophercloud/gophercloud since this issue was created but am holding off on progressing #590. I may just start against this repo and hope the swap is done by the time I'm complete :)

jrperritt commented 8 years ago

Still on track

jrperritt commented 8 years ago

Will be ready on Monday. I have changes locally that will be pushed upstream to gophercloud/gophercloud.

jrperritt commented 8 years ago

Still on track to be done sometime today (Monday). Finishing porting LBaaS v2.

jrperritt commented 8 years ago

The bulk of the work for this has been completed, at least to the point where issues can start being created against the new repo. Please be sure to read the updated README, CONTRIBUTING and STYLEGUIDE documents before contributing.

Unit tests pass, but I haven't touched acceptance tests, for which I'm working on a way to run periodically. I haven't gotten around to adding anything to the CHANGELOG. Most code written against this repo's API should continue to work in the new one. The exceptions off the top of my head are the most recent PR's that I didn't review (LBaaS v2, Volumes v2). For those, there were some naming and implementation issues that were changed for consistency. If you find something that worked here but doesn't in the new repo, please feel free to submit a PR to the MIGRATING file (which is currently empty).

In addition some things are still unstable; error handling, for example. Errors are currently a public API, but that may change soon in favor of an interface approach.