|
| 1 | +# `google-cloud-cpp` v3 Migration Guide |
| 2 | + |
| 3 | +This document is intended for users of previous major versions (v1.x.y, v2.x.y) |
| 4 | +of the `google-cloud-cpp` SDK who are moving to a release on the v3.x.y series. |
| 5 | + |
| 6 | +While this repository does not strictly follow semver, it does use the major |
| 7 | +version number to indicate large breaking changes. We strive to balance the |
| 8 | +frequency in which we introduce breaking changes with improvements to the SDK. |
| 9 | +Since our most recent major version increment, about 3 years ago, we have added |
| 10 | +new API surfaces that supersede the previous deprecated types and functions. As |
| 11 | +part of the v3 release series, we are decommissioning those deprecated API |
| 12 | +surfaces. This guide serves a central location to document how to migrate from |
| 13 | +the decommissioned API surfaces to their replacements. |
| 14 | + |
| 15 | +## C++17 |
| 16 | + |
| 17 | +Depending on your build system of choice, you should set the appropriate flag |
| 18 | +for your compiler if it does not already default to `--std=c++17` or higher. |
| 19 | + |
| 20 | +## Bazel Central Registry |
| 21 | + |
| 22 | +Bazel is moving away from WORKSPACE file support to using modules from the Bazel |
| 23 | +Central Registry. Part of the v3.x.y release series includes supporting the new |
| 24 | +[google-cloud-cpp](https://registry.bazel.build/modules/google_cloud_cpp) Bazel |
| 25 | +module which can be added to your MODULE.bazel file as a dependency. |
| 26 | + |
| 27 | +## Dependencies |
| 28 | + |
| 29 | +### Previously Optional Dependencies that are now Required |
| 30 | + |
| 31 | +- libcurl |
| 32 | +- nlohmann_json |
| 33 | +- opentelemetry-cpp |
| 34 | + |
| 35 | +### Relocated Dependencies |
| 36 | + |
| 37 | +- crc32c |
| 38 | + |
| 39 | +## Decommissioned API Surfaces |
| 40 | + |
| 41 | +### Bazel |
| 42 | + |
| 43 | +### CMake |
| 44 | + |
| 45 | +### Common |
| 46 | + |
| 47 | +### Bigtable |
| 48 | + |
| 49 | +### Pubsub |
| 50 | + |
| 51 | +### Spanner |
| 52 | + |
| 53 | +### Storage |
0 commit comments