Skip to content
This repository was archived by the owner on Dec 31, 2023. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Python Client for Cloud Build API (`GA`_)
============================================

|ga| |pypi| |versions|
|ga| |pypi| |versions|

`Cloud Build API`_: Creates and manages builds on Google Cloud Platform.

Expand Down Expand Up @@ -48,6 +48,15 @@ dependencies.

.. _`virtualenv`: https://virtualenv.pypa.io/en/latest/

Supported Python Versions
^^^^^^^^^^^^^^^^^^^^^^^^^
Python >= 3.6

Deprecated Python Versions
^^^^^^^^^^^^^^^^^^^^^^^^^^
Python == 2.7.

The last version of this library compatible with Python 2.7 is google-cloud-build==1.1.0.

Mac/Linux
^^^^^^^^^
Expand Down Expand Up @@ -81,4 +90,4 @@ Next Steps
APIs that we cover.

.. _Cloud Build API Product documentation: https://cloud.google.com/cloud-build
.. _repository’s main README: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
.. _repository’s main README: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
146 changes: 146 additions & 0 deletions UPGRADING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
# 2.0.0 Migration Guide

The 2.0 release of the `google-cloud-build` client is a significant upgrade based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-python), and includes substantial interface changes. Existing code written for earlier versions of this library will likely require updates to use this version. This document describes the changes that have been made, and what you need to do to update your usage.

If you experience issues or have questions, please file an [issue](https://github.com/googleapis/python-cloudbuild/issues).

## Supported Python Versions

> **WARNING**: Breaking change

The 2.0.0 release requires Python 3.6+.


## Method Calls

> **WARNING**: Breaking change

Methods expect request objects. We provide a script that will convert most common use cases.

* Install the library

```py
python3 -m pip install google-cloud-build
```

* The script `fixup_cloudbuild_v1_keywords.py` is shipped with the library. It expects
an input directory (with the code to convert) and an empty destination directory.

```sh
$ fixup_cloudbuild_v1_keywords.py --input-directory .samples/ --output-directory samples/
```

**Before:**
```py
from google.cloud.devtools import cloudbuild

client = cloudbuild.CloudBuildClient()

build = client.get_build("project_id")
```


**After:**
```py
from google.cloud.devtools import cloudbuild

client = cloudbuild.CloudBuildClient()

build = client.get_build(request = {'project_id': "project_id"})
```

### More Details

In `google-cloud-build<2.0.0`, parameters required by the API were positional parameters and optional parameters were keyword parameters.

**Before:**
```py
def list_builds(
self,
project_id,
page_size=None,
filter_=None,
retry=google.api_core.gapic_v1.method.DEFAULT,
timeout=google.api_core.gapic_v1.method.DEFAULT,
metadata=None,
):
```

In the 2.0.0 release, all methods have a single positional parameter `request`. Method docstrings indicate whether a parameter is required or optional.

Some methods have additional keyword only parameters. The available parameters depend on the [`google.api.method_signature` annotation](https://github.com/googleapis/googleapis/blob/master/google/devtools/cloudbuild/v1/cloudbuild.proto#L82) specified by the API producer.


**After:**
```py
def list_builds(
self,
request: cloudbuild.ListBuildsRequest = None,
*,
project_id: str = None,
filter: str = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> pagers.ListBuildsPager:
```

> **NOTE:** The `request` parameter and flattened keyword parameters for the API are mutually exclusive.
> Passing both will result in an error.


Both of these calls are valid:

```py
response = client.list_builds(
request={
"project_id": project_id,
"filter": filter,
}
)
```

```py
response = client.list_builds(
project_id=project_id,
filter=filter,
)
```

This call is invalid because it mixes `request` with a keyword argument `filter`. Executing this code
will result in an error.

```py
response = client.list_builds(
request={
"project_id": project_id,
},
filter=filter
)
```



## Enums and Types


> **WARNING**: Breaking change

The submodules `enums` and `types` have been removed.

**Before:**
```py
from google.cloud.devtools import cloudbuild

build_status = cloudbuild.enums.Build.Status.SUCCESS
built_image = cloudbuild.types.BuiltImage(name="name")
```


**After:**
```py
from google.cloud.devtools import cloudbuild

build_status = cloudbuild.Build.Status.SUCCESS
built_image = cloudbuild.BuiltImage(name="name")
```
1 change: 1 addition & 0 deletions docs/UPGRADING.md
6 changes: 6 additions & 0 deletions docs/cloudbuild_v1/services.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Services for Google Devtools Cloudbuild v1 API
==============================================

.. automodule:: google.cloud.devtools.cloudbuild_v1.services.cloud_build
:members:
:inherited-members:
5 changes: 5 additions & 0 deletions docs/cloudbuild_v1/types.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
Types for Google Devtools Cloudbuild v1 API
===========================================

.. automodule:: google.cloud.devtools.cloudbuild_v1.types
:members:
6 changes: 0 additions & 6 deletions docs/gapic/v1/api.rst

This file was deleted.

5 changes: 0 additions & 5 deletions docs/gapic/v1/types.rst

This file was deleted.

15 changes: 13 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,19 @@ API Reference
.. toctree::
:maxdepth: 2

gapic/v1/api
gapic/v1/types
cloudbuild_v1/services
cloudbuild_v1/types


Migration Guide
---------------

See the guide below for instructions on migrating to the 2.x release of this library.

.. toctree::
:maxdepth: 2

UPGRADING


Changelog
Expand Down
24 changes: 0 additions & 24 deletions google/cloud/devtools/__init__.py

This file was deleted.

29 changes: 0 additions & 29 deletions google/cloud/devtools/cloudbuild.py

This file was deleted.

Loading