A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://cloud.google.com/appengine/docs/standard/java/tools/migrate-gradle below:

Migrating to the gcloud CLI-based Gradle plugin | App Engine standard environment for Java 8

Migrating to the gcloud CLI-based Gradle plugin

Stay organized with collections Save and categorize content based on your preferences.

If you previously used the Java App Engine SDK-based plugin (com.google.appengine.appengine-gradle) and want to move to the new Google Cloud CLI, migrate to the gcloud CLI-based (com.google.cloud.tools.appengine-gradle) plugin.

Benefits of the gcloud CLI-based plugin

Upgrading to the new plugin provides the following benefits:

Notable differences

Before you migrate, be aware of these notable differences:

gcloud CLI dependency
The old plugin runs without any specific local environment dependencies, besides Java, but the new plugin requires that you have the gcloud CLI installed.
No Endpoints discovery doc generation
The new plugin does not generate Endpoints discovery docs, a feature available in a separate plugin. Running your Endpoints backend no longer requires generating this file in a build step as the server now generates it at runtime. You should use the new plugin only if you need to generate client libraries such as for iOS or Android. Learn more about the new plugins by reviewing the Migrating to Endpoints Frameworks for App Engine guide.
EAR file format no longer supported
The new plugin no longer supports the EAR file format for running and deploying multiple services at the same time.
New deployment command
The old plugin calls the appcfg command to deploy applications, while the new plugin deploys using the new gcloud CLI.
JPA/JDO Datanucleus enhancement must be manually configured
If your project uses the gradle-appengine-plugin’s JPA/JDO Datanucleus enhancement, you must manually configure Datanucleus enhancement after switching to the gcloud CLI-based plugin. See an example from Stackoverflow.
Android Studio is not supported
You can switch your Android Studio project to use the new plugin, but the Android Studio App Engine development server and deployment support does not work with this new plugin. To run and deploy your app, you have to invoke Gradle directly.

Use of XML configuration files is supported, but not YAML.

Migrating to the new plugin
  1. Remove the old gradle-appengine-plugin configuration and imports from your build.gradle file.

  2. Add the new plugin to the classpath of your build.gradle file's buildscript section:

    buildscript {
        repositories {
            mavenCentral()
        }
    
        dependencies {
            classpath 'com.google.cloud.tools:appengine-gradle-plugin:2.0.1'
        }
    }
    
  3. At the root of your service, run the following command to verify that you can run your app locally:

    gradle appengineRun
    
  4. In your build.gradle file's buildscript section, configure your deployment by specifying your project ID and version:

    appengine {
        deploy {
            version = 'v1'
            project = "your GCP project ID"
        }
    }
    

    The new tooling ignores the application and version elements in your appengine-web.xml file.

  5. At the root of your service, run the following command to verify that you can deploy your application:

    gradle appengineDeploy
    
Migrating EAR based multi-service configurations

The new plugin does not support EAR packaging. Instead, it supports running multiple services locally without any special packaging steps.

To migrate your EAR-based Gradle project:

  1. Pick a primary service that will be responsible for running the rest of the services. You should select your default service, but it can be any of the services that are run together.

  2. In your appengine configuration, modify the run.services entry to include all the services that should be run by the local development server.

    An example project structure:

    ../{projectRoot}/
      build.gradle
      settings.gradle (includes default-service & secondary-service)
           {your-default-service}/build.gradle {includes appengine-gradle-plugin}
              .
           {your-default-service}/src/main/webapp/WEB-INF/appengine-web.xml
           {your-secondary-service}build.gradle {includes appengine-gradle-plugin}
              .
           {your-secondary-service}/src/main/webapp/WEB-INF/appengine-web.xml
    

    An example build.gradle buildscript:

    appengine {
        run {
            // configure the app to point to the right service directories
            services = [
                    projectAsService(project),
                    projectAsService(":another-module")
            ]
        }
    }
    
    // helper method to obtain correct directory and set up dependencies
    def getExplodedAppDir(Project serverProject) {
        // if not 'this' module, then do some setup.
        if (serverProject != project) {
            // make sure we evaluate other modules first so we get the right value
            evaluationDependsOn(serverProject.path)
            // make sure we build "run" depends on the other modules exploding wars
            project.tasks.appengineRun.dependsOn serverProject.tasks.explodeWar
        }
        return serverProject.tasks.explodeWar.explodedAppDirectory
    }
    
App Engine SDK-based vs gcloud CLI-based Gradle commands

The following table shows the different ways you invoke the Gradle plugin, depending on whether you use the App Engine SDK-based Gradle plugin or the gcloud CLI-based Gradle plugin.

Action App Engine SDK-based gcloud CLI-based Run the app locally appengine:devserver appengineRun Deploy a new app, version, or service. appengine:update appengineDeploy Set the default application version. appengine:set_default_version gcloud app services set-traffic or gcloud app versions migrate Update application cron jobs. appengine:update_cron appengineDeployCron Update the application dispatch configuration. appengine:update_dispatch appengineDeployDispatch Update application DoS protection configuration. appengine:update_dos appengineDeployDos Update application task queue definitions. appengine:update_queues appengineDeployQueue Update Datastore Indexes. appengine:update_indexes appengineDeployIndex Delete unused indexes from application. appengine:vacuum_indexes gcloud datastore indexes cleanup Start the specified module version. appengine:start_module_version gcloud app versions start Stop the specified module version. appengine:stop_module_version gcloud app versions stop Rollback an in-progress update. appengine:rollback gcloud app versions start, gcloud app versions stop What's next

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-08-07 UTC.

[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-07 UTC."],[[["Migrate from the Java App Engine SDK-based plugin (`com.google.appengine.appengine-gradle`) to the gcloud CLI-based plugin (`com.google.cloud.tools.appengine-gradle`) for enhanced benefits, including unified authentication, flexible environment support, and automatic updates."],["The new gcloud CLI-based plugin requires the gcloud CLI to be installed and no longer supports Endpoints discovery doc generation within the plugin, as it's now handled at runtime, nor does it support the EAR file format for multiple services."],["Manual configuration of Datanucleus enhancement is necessary if your project uses JPA/JDO, and Android Studio's built-in App Engine support is incompatible, requiring direct Gradle invocation."],["Migrating from EAR-based multi-service configurations to the new plugin involves selecting a primary service and configuring the `run.services` entry in your `build.gradle` to include all services for local development, replacing EAR packaging entirely."],["The gcloud CLI-based plugin uses new Gradle commands like `appengineRun` for local development and `appengineDeploy` for deployment, replacing the old SDK-based commands such as `appengine:devserver` and `appengine:update`."]]],[]]


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4