{"id":13485180,"url":"https://github.com/google-github-actions/deploy-appengine","last_synced_at":"2025-04-07T17:07:38.663Z","repository":{"id":37464955,"uuid":"308778040","full_name":"google-github-actions/deploy-appengine","owner":"google-github-actions","description":"A GitHub Action that deploys source code to Google App Engine.","archived":false,"fork":false,"pushed_at":"2024-09-13T00:12:27.000Z","size":3140,"stargazers_count":252,"open_issues_count":4,"forks_count":71,"subscribers_count":7,"default_branch":"main","last_synced_at":"2024-10-14T12:10:41.660Z","etag":null,"topics":["actions","app-engine","appengine","gae","gcp","github-actions","google-app-engine","google-appengine","google-cloud","google-cloud-platform"],"latest_commit_sha":null,"homepage":"https://cloud.google.com/appengine","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/google-github-actions.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-10-31T01:09:26.000Z","updated_at":"2024-09-28T22:40:53.000Z","dependencies_parsed_at":"2023-01-08T03:54:41.350Z","dependency_job_id":"7ef5ae7d-4b37-4b21-a2c3-9c9b346be7c4","html_url":"https://github.com/google-github-actions/deploy-appengine","commit_stats":{"total_commits":199,"total_committers":16,"mean_commits":12.4375,"dds":0.6331658291457287,"last_synced_commit":"24e0c36ed7593b83beee803db490735c270338d6"},"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/google-github-actions%2Fdeploy-appengine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/google-github-actions%2Fdeploy-appengine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/google-github-actions%2Fdeploy-appengine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/google-github-actions%2Fdeploy-appengine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/google-github-actions","download_url":"https://codeload.github.com/google-github-actions/deploy-appengine/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247694875,"owners_count":20980733,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["actions","app-engine","appengine","gae","gcp","github-actions","google-app-engine","google-appengine","google-cloud","google-cloud-platform"],"created_at":"2024-07-31T17:01:49.335Z","updated_at":"2025-04-07T17:07:38.629Z","avatar_url":"https://github.com/google-github-actions.png","language":"TypeScript","readme":"# deploy-appengine\n\nThis action deploys your source code to [App Engine][gae] and makes the URL\navailable to later build steps via outputs. This allows you to parameterize your\nApp Engine deployments.\n\n**This is not an officially supported Google product, and it is not covered by a\nGoogle Cloud support contract. To report bugs or request features in a Google\nCloud product, please contact [Google Cloud\nsupport](https://cloud.google.com/support).**\n\n\n## Prerequisites\n\n-   This action requires Google Cloud credentials that are authorized to deploy\n    an App Engine Application. See the [Authorization](#authorization) section\n    below for more information.\n\n-   This action runs using Node 20. If you are using self-hosted GitHub Actions\n    runners, you must use runner version [2.285.0](https://github.com/actions/virtual-environments)\n    or newer.\n\n## Usage\n\n```yaml\njobs:\n  job_id:\n    permissions:\n      contents: 'read'\n      id-token: 'write'\n\n    steps:\n    - id: 'auth'\n      uses: 'google-github-actions/auth@v2'\n      with:\n        workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider'\n        service_account: 'my-service-account@my-project.iam.gserviceaccount.com'\n\n    - id: 'deploy'\n      uses: 'google-github-actions/deploy-appengine@v2'\n\n    # Example of using the output\n    - id: 'test'\n      run: 'curl \"${{ steps.deploy.outputs.version_url }}\"'\n```\n\n## Inputs\n\n-   `project_id`: (Optional) ID of the Google Cloud project. If not provided,\n    this is inherited from the environment.\n\n-   `working_directory`: (Optional) The working directory to use. **Actions do\n    not honor [default working-directory\n    settings](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#defaultsrun).**\n    The `deliverables` input is a relative path based on this setting.\n\n-   `deliverables`: (Optional) The [yaml\n    files](https://cloud.google.com/appengine/docs/standard/nodejs/configuration-files#optional_configuration_files)\n    for the services or configurations you want to deploy. If not given,\n    defaults to app.yaml in the current directory. If that is not found,\n    attempts to automatically generate necessary configuration files (such as\n    app.yaml) in the current directory (example, `app.yaml cron.yaml`). Note:\n    the additional deliverables may require additional roles for your service\n    account user.\n\n-   `build_env_vars`: (Optional) List of key=value pairs to set as environment\n    variables during tbe build process. This will overwrite any duplicate key\n    environment variables defined in the app.yaml.\n\n    ```yaml\n    with:\n      build_env_vars: |-\n        FOO=bar\n        ZIP=zap\n    ```\n\n    Note: To include environment variables defined in another file, use the\n    [`includes` directive][includes-directive] in your app.yaml.\n\n-   `env_vars`: (Optional) List of key=value pairs to set as environment\n    variables. This will overwrite any duplicate key environment variables\n    defined in the app.yaml.\n\n    ```yaml\n    with:\n      env_vars: |-\n        FOO=bar\n        ZIP=zap\n    ```\n\n    Note: To include environment variables defined in another file, use the\n    [`includes` directive][includes-directive] in your app.yaml.\n\n-   `image_url`: (Optional) Deploy with a specific container image. The image\n    url must be from one of the valid GCR hostnames (example, `gcr.io/`).\n\n-   `version`: (Optional) The version of the app that will be created or\n    replaced by this deployment. If you do not specify a version, one will be\n    generated for you.\n\n-   `promote`: (Optional) Promote the deployed version to receive all traffic.\n    The default is `true`.\n\n-   `flags`: (Optional) Space-separated list of other App Engine flags. This can\n    be used to access features that are not exposed via this GitHub Action.\n\n    ```yaml\n    with:\n      flags: '--ignore-file=...'\n    ```\n\n    See the [complete list of flags](https://cloud.google.com/sdk/gcloud/reference/app/deploy#FLAGS) for more information.\n\n---\n\n-   `gcloud_version`: (Optional) Version of the gcloud CLI to use. The default value is `latest`.\n\n-   `gcloud_component`: (Optional) Component of the gcloud CLI to use. Valid\n    values are `alpha` and `beta`. The default value is to use the stable track.\n\n### app.yaml customizations\n\nOther application configurations can be customized through the app.yaml, ie the\nservice name. See [app.yaml Configuration File](https://cloud.google.com/appengine/docs/standard/nodejs/config/appref)\nfor more information.\n\n## Outputs\n\n-   `name`: The fully-qualified resource name of the deployment. This will be of\n    the format \"apps/\u003cproject\u003e/services/\u003cservice\u003e/versions/\u003cversion\u003e\".\n\n-   `runtime`: The computed deployment runtime.\n\n-   `service_account_email`: The email address of the runtime service account.\n\n-   `serving_status`: The current serving status. The value is usually\n    \"SERVING\", unless the deployment failed to start.\n\n-   `version_id`: Unique identifier for the version, or the specified version if\n    one was given.\n\n-   `version_url`: URL of the version of the AppEngine service that was\n    deployed.\n\n## Authorization\n\nThere are a few ways to authenticate this action. The caller must have the following [Google Cloud IAM Roles](https://cloud.google.com/appengine/docs/standard/python/roles#predefined_roles):\n\n-   App Engine Admin (`roles/appengine.appAdmin`) to manage all App Engine\n    resources and create new services and versions.\n\n-   Storage Admin (`roles/storage.admin`) to upload files to Cloud Storage to\n    store source artifacts.\n\n-   Cloud Build Editor (`roles/cloudbuild.builds.editor`) to build the\n    service.\n\n-   Artifact Registry Reader (`roles/artifactregistry.reader`) to view \u0026 get artifacts for implementing CI/CD pipeline.\n\n-   Service Account User (`roles/iam.serviceAccountUser`) permissions on the\n    runtime service account to deploy the service. The default runtime service\n    account is `PROJECT_ID@appspot.gserviceaccount.com`, but you can also\n    customize the service account in your app.yaml file.\n\n-   _(optional)_ Cloud Scheduler Admin (`roles/cloudscheduler.admin`) to\n    schedule tasks\n\n*Note:* An owner will be needed to create the App Engine application.\n\n### Via google-github-actions/auth\n\nUse [google-github-actions/auth](https://github.com/google-github-actions/auth) to authenticate the action. This Action supports both the recommended [Workload Identity Federation][wif] based authentication and the traditional [Service Account Key JSON][sa] based auth.\n\n```yaml\njobs:\n  job_id:\n    permissions:\n      contents: 'read'\n      id-token: 'write'\n\n    steps:\n    - id: 'auth'\n      uses: 'google-github-actions/auth@v2'\n      with:\n        workload_identity_provider: 'projects/123456789/locations/global/workloadIdentityPools/my-pool/providers/my-provider'\n        service_account: 'my-service-account@my-project.iam.gserviceaccount.com'\n\n    - id: 'deploy'\n      uses: 'google-github-actions/deploy-appengine@v2'\n```\n\n### Via Application Default Credentials\n\nIf you are hosting your own runners, **and** those runners are on Google Cloud,\nyou can leverage the Application Default Credentials of the instance. This will\nauthenticate requests as the service account attached to the instance. **This\nonly works using a custom runner hosted on GCP.**\n\n```yaml\njobs:\n  job_id:\n    steps:\n    - id: 'deploy'\n      uses: 'google-github-actions/deploy-appengine@v2'\n```\n\n## Advanced Configuration\n\n#### Custom Build Timeouts\n\nThe default Google Cloud Build timeout to compile the application may be too\nshort for some services. To extend the build timeout, set the\n`CLOUDSDK_APP_CLOUD_BUILD_TIMEOUT` environment variable to an integer\nrepresenting the number of seconds for the timeout. Do not customize this value\nunless you are getting errors about build timeouts. This will consume more build\nminutes.\n\n```yaml\njobs:\n  job_id:\n    steps:\n    - uses: 'google-github-actions/deploy-appengine@v2'\n      env:\n        CLOUDSDK_APP_CLOUD_BUILD_TIMEOUT: 1800 # 30 minutes\n```\n\n\n[gae]: https://cloud.google.com/appengine\n[sm]: https://cloud.google.com/secret-manager\n[sa]: https://cloud.google.com/iam/docs/creating-managing-service-accounts\n[wif]: https://cloud.google.com/iam/docs/workload-identity-federation\n[gh-runners]: https://help.github.com/en/actions/hosting-your-own-runners/about-self-hosted-runners\n[gh-secret]: https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets\n[setup-gcloud]: https://github.com/google-github-actions/setup-gcloud/\n[roles]: https://cloud.google.com/iam/docs/granting-roles-to-service-accounts#granting_access_to_a_service_account_for_a_resource\n[create-key]: https://cloud.google.com/iam/docs/creating-managing-service-account-keys\n[app-engine-admin-api]: https://console.cloud.google.com/apis/api/appengine.googleapis.com/overview\n[app-engine-nodejs-docs]: https://cloud.google.com/appengine/docs/standard/nodejs/console#console\n[includes-directive]: https://cloud.google.com/appengine/docs/legacy/standard/python/config/appref#includes\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoogle-github-actions%2Fdeploy-appengine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgoogle-github-actions%2Fdeploy-appengine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgoogle-github-actions%2Fdeploy-appengine/lists"}