GoogleCloudPlatform / app-gradle-plugin

The library has moved to https://github.com/GoogleCloudPlatform/appengine-plugins/tree/main/app-gradle-plugin

🚌 In February 2024, this library has moved to appengine-plugins/app-gradle-plugin. This repository will be archived in the future. Future releases will appear in the new repository (https://github.com/GoogleCloudPlatform/appengine-plugins/releases). The Maven artifact coordinates (com.google.cloud.tools:appengine-gradle-plugin) remain the same.

Google App Engine Gradle plugin

This Gradle plugin provides tasks to build and deploy Google App Engine applications.

Requirements

Gradle is required to build and run the plugin. Version compatibility is listed below.

appengine-gradle-plugin	gradle version
2.0.0 +	4.0 or newer
1.3.3 +	3.4.1 or newer
1.0.0 - 1.3.2	3.0 or newer

Google Cloud SDK is required but will be automatically installed by the plugin.

How to use

The plugin needs to be defined in your build.gradle. It is directly available on Maven Central. Alternatively, you can download it from GitHub and deploy it to your local repository. The following code snippet shows an example on how to retrieve it from Maven Central:

Using plugins block

Since the appengine-gradle-plugin is not published to the gradle plugin portal, you must refrence it from the Central Maven repository. Add the maven central resolution to your settings.gradle

pluginManagement {
  repositories {
    gradlePluginPortal()
    mavenCentral()
    // add mavenLocal() if you are using a locally built version of the plugin
  }
  resolutionStrategy {
    eachPlugin {
      if (requested.id.id.startsWith('com.google.cloud.tools.appengine')) {
        useModule("com.google.cloud.tools:appengine-gradle-plugin:${requested.version}")
      }
    }
  }
}

Apply the plugin in your plugins block in your build.gradle

plugins {
  id 'com.google.cloud.tools.appengine' version '2.4.4'
}

Using buildscript block

If you wish to apply the plugin via the legacy buildscript mechanism, add the following to your build.gradle.

buildscript {
  repositories {
    mavenCentral()
  }

  dependencies {
    classpath 'com.google.cloud.tools:appengine-gradle-plugin:2.4.4'
  }
}

apply plugin: 'com.google.cloud.tools.appengine'

You can now run commands like ./gradlew appengineDeploy on your Java application.

Goals and Configuration

Please see the USER GUIDE for a full list of supported goals and configuration options.

• USER_GUIDE for app.yaml based projects
• USER_GUIDE for appengine-web.xml based projects

Reference Documentation

App Engine Standard Environment:

• (Java 8) Using Gradle and the App Engine Plugin (standard environment)
• (Java 8) App Engine Gradle Plugin Tasks and Parameters (standard environment)
• Using Gradle and the App Engine Plugin (standard environment)
• App Engine Gradle Plugin Tasks and Parameters (standard environment)

App Engine Flexible Environment:

• Using Gradle and the App Engine Plugin (flexible environment)
• App Engine Gradle Plugin Tasks and Parameters (flexible environment)

Contributing

If you wish to contribute to this plugin, please see the contributor instructions.