Skip to content

Commit 77c693a

Browse files
committed
doc(v3): add first draft of migration guide with links to it
1 parent febba47 commit 77c693a

File tree

3 files changed

+59
-0
lines changed

3 files changed

+59
-0
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Changelog
22

3+
**NOTE**: Please refer to the [V3 Migration Guide](doc/v3-migration-guide.md)
4+
for details on updating existing applications using v1.x.y or v2.x.y.
5+
36
**NOTE**: [Future Breaking Changes](/doc/deprecated.md) lists anticipated
47
breaking changes in the upcoming 3.x release. This release is scheduled for
58
2024-12 or 2025-01.

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010
This repository contains idiomatic C++ client libraries for the following
1111
[Google Cloud Platform](https://cloud.google.com/) services.
1212

13+
> Please refer to the [V3 Migration Guide](doc/v3-migration-guide.md) for
14+
> details on updating existing applications using v1.x.y or v2.x.y.
15+
1316
> Please check the [CHANGELOG] for important announcements and upcoming changes.
1417
1518
## Quickstart

doc/v3-migration-guide.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
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

Comments
 (0)