Skip to content

Commit f00f1fe

Browse files
committed
Add documentation for Cloud Build timeouts
Fixes GH-221
1 parent 490d083 commit f00f1fe

File tree

1 file changed

+16
-29
lines changed

1 file changed

+16
-29
lines changed

README.md

Lines changed: 16 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -161,40 +161,27 @@ jobs:
161161
uses: 'google-github-actions/deploy-appengine@v1'
162162
```
163163

164-
## Example Workflows
164+
## Advanced Configuration
165165

166-
* [Deploy from source](#deploy-from-source)
166+
#### Custom Build Timeouts
167167

168-
### Setup
168+
The default Google Cloud Build timeout to compile the application may be too
169+
short for some services. To extend the build timeout, set the
170+
`CLOUDSDK_APP_CLOUD_BUILD_TIMEOUT` environment variable to an integer
171+
representing the number of seconds for the timeout. Do not customize this value
172+
unless you are getting errors about build timeouts. This will consume more build
173+
minutes.
169174

170-
1. Clone this repo.
171-
172-
1. Create a new Google Cloud Project (or select an existing project).
173-
174-
1. [Initialize your App Engine app with your project][app-engine-nodejs-docs].
175-
176-
1. Enable the [App Engine Admin API][app-engine-admin-api] on your project.
177-
178-
1. [Create a Google Cloud service account][sa] or select an existing one.
179-
180-
1. Add [required roles](#authorization) to [your service account][roles].
181-
182-
1. [Download a JSON service account key][create-key] for the service account.
183-
184-
1. Add the following [secrets to your repository's secrets][gh-secret]:
185-
186-
- `GCP_PROJECT`: Google Cloud project ID
187-
188-
- `GCP_SA_KEY`: the downloaded service account key
189-
190-
### Deploy from source
191-
192-
To run this workflow, push to the branch named `example`:
193-
194-
```sh
195-
git push YOUR-FORK main:example
175+
```yaml
176+
jobs:
177+
job_id:
178+
steps:
179+
- uses: 'google-github-actions/deploy-appengine@v1'
180+
env:
181+
CLOUDSDK_APP_CLOUD_BUILD_TIMEOUT: 1800 # 30 minutes
196182
```
197183

184+
198185
[gae]: https://cloud.google.com/appengine
199186
[sm]: https://cloud.google.com/secret-manager
200187
[sa]: https://cloud.google.com/iam/docs/creating-managing-service-accounts

0 commit comments

Comments
 (0)