Tâches et propriétés du plug-in Gradle pour App Engine

Une fois que le plug-in Gradle pour App Engine est ajouté à votre projet, vous pouvez utiliser les tâches Gradle spécifiques à App Engine dans votre application Java 8 :

Tâche	Description
`tasks`	Affiche des informations d'aide sur les tâches installées.
`appengineStage`	Génère un répertoire d'application pour le déploiement.
`appengineDeploy`	Prépare et déploie une application sur App Engine.
`appengineDeployCron`	Déploie un fichier de configuration `cron.yaml` sur App Engine.
`appengineDeployDispatch`	Déploie un fichier de configuration `dispatch.yaml` sur App Engine
`appengineDeployDos`	Déploie un fichier de configuration `dos.yaml` sur App Engine.
`appengineDeployIndex`	Déploie un fichier de configuration `index.yaml` sur App Engine.
`appengineDeployQueue`	Déploie un fichier de configuration `queue.yaml` sur App Engine.
`jettyRun`	Exécute le serveur de développement à l'aide des configurations par défaut de Jetty. Pour en savoir plus sur le plug-in Gretty, consultez les sections Configuration Gretty et Tâches Gretty.

Pour afficher la liste de toutes les tâches, saisissez la commande suivante :

gradle tasks

Pour en savoir plus sur la configuration et l'utilisation de Gradle, consultez la page Utiliser le plug-in Gradle d'App Engine et le dépôt app-gradle-plugin sur GitHub.

Propriétés de tâches

Le contenu du fichier gradle.build est un ensemble de règles décrivant votre build. Il est écrit dans un langage spécifique à un domaine servant à décrire les builds, basé sur le langage Groovy.

Chaque tâche dispose des propriétés associées ci-dessous que vous pouvez utiliser. Vous pouvez spécifier ces propriétés dans le fichier gradle.build à l'aide d'une fermeture de configuration, d'une tâche et de propriétés.

L'exemple suivant montre comment spécifier des tâches Gradle pour Java 8. Pour Java version 11 ou ultérieure, consultez la page Environnement d'exécution Java pour en savoir plus sur l'utilisation des versions plus récentes.

Dans cet exemple :

La fermeture de la configuration du plug-in est appengine.
La tâche est deploy.
Les propriétés stopPreviousVersion et promote sont définies sur true.

appengine {
  deploy {   // deploy configuration
    stopPreviousVersion = true  // default - stop the current version
    promote = true              // default - & make this the current version
  }
}

Si vous ne devez spécifier que certaines propriétés, vous pouvez les définir sur une seule ligne, comme suit :

  appengine.deploy.stopPreviousVersion = true

Pour obtenir la liste des propriétés disponibles pour chaque tâche, consultez les sections suivantes.

appengineStage

task(stage)

Génère un répertoire d'application pour le déploiement. Utilisé par la tâche appengineDeploy et la tâche jettyRun.

Vous pouvez utiliser les propriétés ci-après :

Propriété	Description
`artifact`	Artefact de compilation qui dispose de l'ensemble des classes, ressources et fichiers manifestes. La valeur par défaut est `build/libs/[YOUR_SERVLET].war`.
`appEngineDirectory`	Emplacement du fichier `app.yaml`. La valeur par défaut est `src/main/appengine`.
`dockerDirectory`	Emplacement du fichier `Dockerfile`. La valeur par défaut est `src/main/docker`.
`stagingDirectory`	Obligatoire. Répertoire dans lequel placer l'application. La valeur par défaut est `build/staged-app`.

appengineDeploy

task(deploy)

Organise et déploie une application sur App Engine.

Dans l'exemple suivant :

La fermeture de la configuration du plug-in est appengine.
La tâche est run.
La propriété port est définie sur 8080.

appengine {  // App Engine tasks configuration
  run {      // local (dev_appserver) configuration (standard environments only)
    port = 8080                 // default
  }

  deploy {   // deploy configuration
    stopPreviousVersion = true  // default - stop the current version
    promote = true              // default - & make this the current version
  }
}

Si vous ne devez spécifier que certaines propriétés, vous pouvez les définir sur une seule ligne, comme suit :

  appengine.run.port = 8888

Propriété	Description
`appEngineDirectory`	Emplacement des fichiers de configuration `.yaml` (Cron, index, etc.) à partir desquels les déploiements spécifiques à la configuration (appengineDeployCron, etc.) seront effectués. Pour les applications flexibles, `src/main/appengine` est la valeur par défaut.
`bucket`	Bucket Cloud Storage utilisé pour organiser les fichiers associés au déploiement. Si cet argument n'est pas spécifié, le bucket par défaut de l'application est utilisé.
`deployables`	Fichiers YAML pour les services ou les configurations que vous souhaitez déployer. Le fichier par défaut est `app.yaml` dans le répertoire de préproduction. Si ce n'est pas le cas, essayez de générer automatiquement les fichiers de configuration nécessaires (tels que `app.yaml`) dans le répertoire de préproduction.
`imageUrl`	À déployer avec une image Docker spécifique. L'URL Docker doit provenir de l'un des noms d'hôte valides d'Artifact Registry.
`project`	Nom du projet Google Cloud Platform à utiliser pour cet appel. Le projet par défaut est celui en cours sélectionné lors de l'initialisation de l'outil gcloud. Pour vérifier que le projet sélectionné est correct, exécutez la commande `gcloud config list project`.
`promote`	Passe à la version déployée pour recevoir tout le trafic La valeur par défaut est "True".
`server`	Serveur App Engine auquel se connecter. En règle générale, il n'est pas nécessaire de modifier cette valeur.
`stopPreviousVersion`	Arrête la version précédemment en cours d'exécution lors du déploiement d'une nouvelle version recevant tout le trafic.
`version`	Version de l'application qui sera créée ou remplacée par ce déploiement. Si vous ne spécifiez pas de version, une version sera générée pour vous.

Propriétés globales

Propriété	Description
`tools.cloudSdkHome`	Propriété facultative permettant de configurer l'emplacement de Google Cloud CLI. En règle générale, le plug-in trouve cette propriété dans la CLI gcloud lorsqu'il est installé à l'aide de la commande `gcloud components install app-engine-java`.