ServiceFabricUpdateManifests@2 - Tâche Mettre à jour les manifestes Service Fabric v2

  • Article

Utilisez cette tâche dans un pipeline de build pour mettre à jour automatiquement les versions d’une application Service Fabric empaquetée. Cette tâche ajoute un suffixe de version à toutes les versions de service et d’application, spécifiées dans les fichiers manifeste, dans un package d’application Azure Service Fabric.

Syntaxe

# Update Service Fabric manifests v2
# Automatically update portions of application and service manifests in a packaged Azure Service Fabric application.
- task: ServiceFabricUpdateManifests@2
  inputs:
    updateType: 'Manifest versions' # 'Manifest versions' | 'Docker image settings'. Required. Update Type. Default: Manifest versions.
    applicationPackagePath: # string. Required. Application Package. 
    #versionSuffix: '.$(Build.BuildNumber)' # string. Required when updateType = Manifest versions. Version Value. Default: .$(Build.BuildNumber).
    #versionBehavior: 'Append' # 'Append' | 'Replace'. Optional. Use when updateType = Manifest versions. Version Behavior. Default: Append.
    #updateOnlyChanged: false # boolean. Optional. Use when updateType = Manifest versions. Update only if changed. Default: false.
    #pkgArtifactName: # string. Optional. Use when updateType = Manifest versions && updateOnlyChanged = true. Package Artifact Name. 
    #logAllChanges: true # boolean. Optional. Use when updateType = Manifest versions && updateOnlyChanged = true. Log all changes. Default: true.
    #compareType: 'LastSuccessful' # 'LastSuccessful' | 'Specific'. Optional. Use when updateType = Manifest versions && updateOnlyChanged = true. Compare against. Default: LastSuccessful.
    #buildNumber: # string. Optional. Use when updateType = Manifest versions && compareType = Specific. Build Number. 
    #overwriteExistingPkgArtifact: true # boolean. Optional. Use when updateType = Manifest versions && updateOnlyChanged = true. Overwrite Existing Package Artifact. Default: true.
    #imageNamesPath: # string. Optional. Use when updateType = Docker image settings. Image Names Path. 
    #imageDigestsPath: # string. Required when updateType = Docker image settings. Image Digests Path.

# Update Service Fabric Manifests v2
# Automatically updates portions of the application and service manifests within a packaged Service Fabric application.
- task: ServiceFabricUpdateManifests@2
  inputs:
    updateType: 'Manifest versions' # 'Manifest versions' | 'Docker image settings'. Required. Update Type. Default: Manifest versions.
    applicationPackagePath: # string. Required. Application Package. 
    #versionSuffix: '.$(Build.BuildNumber)' # string. Required when updateType = Manifest versions. Version Value. Default: .$(Build.BuildNumber).
    #versionBehavior: 'Append' # 'Append' | 'Replace'. Optional. Use when updateType = Manifest versions. Version Behavior. Default: Append.
    #updateOnlyChanged: false # boolean. Optional. Use when updateType = Manifest versions. Update only if changed. Default: false.
    #pkgArtifactName: # string. Optional. Use when updateType = Manifest versions && updateOnlyChanged = true. Package Artifact Name. 
    #logAllChanges: true # boolean. Optional. Use when updateType = Manifest versions && updateOnlyChanged = true. Log all changes. Default: true.
    #compareType: 'LastSuccessful' # 'LastSuccessful' | 'Specific'. Optional. Use when updateType = Manifest versions && updateOnlyChanged = true. Compare against. Default: LastSuccessful.
    #buildNumber: # string. Optional. Use when updateType = Manifest versions && compareType = Specific. Build Number. 
    #overwriteExistingPkgArtifact: true # boolean. Optional. Use when updateType = Manifest versions && updateOnlyChanged = true. Overwrite Existing Package Artifact. Default: true.
    #imageNamesPath: # string. Optional. Use when updateType = Docker image settings. Image Names Path. 
    #imageDigestsPath: # string. Required when updateType = Docker image settings. Image Digests Path.

Entrées

updateType - Type de mise à jour
string. Obligatoire. Valeurs autorisées : Manifest versions, Docker image settings. Valeur par défaut : Manifest versions.

Spécifie le type de mise à jour à effectuer dans les fichiers manifeste. Pour utiliser les deux types de mise à jour, ajoutez une instance de cette tâche au pipeline de build pour chaque type de mise à jour à exécuter.


applicationPackagePath - Package d’application
string. Obligatoire.

Spécifie le chemin d’accès au package d’application. Les variables et les caractères génériques peuvent être utilisés dans le chemin d’accès. applicationPackagePath ne doit pas avoir de barre oblique de fin, soit \ ou /.


versionSuffix - Valeur de version
string. Obligatoire lorsque updateType = Manifest versions. Valeur par défaut : .$(Build.BuildNumber).

Spécifie la version dans les fichiers manifestes.

Conseil

Vous pouvez modifier le format de numéro de build directement ou utiliser une commande de journalisation pour définir dynamiquement une variable dans un format. Par exemple, vous pouvez utiliser $(VersionSuffix) défini dans une tâche PowerShell :

$versionSuffix = ".$([DateTimeOffset]::UtcNow.ToString('yyyyMMdd.HHmmss'))"
Write-Host "##vso[task.setvariable variable=VersionSuffix;]$versionSuffix"

versionBehavior - Comportement de version
string. Optionnel. Utilisez quand updateType = Manifest versions. Valeurs autorisées : Append, Replace. Valeur par défaut : Append.

Spécifie s’il faut ajouter la valeur de version aux valeurs existantes dans les fichiers manifestes ou les remplacer.


updateOnlyChanged - Mettre à jour uniquement en cas de modification
boolean. Optionnel. Utilisez quand updateType = Manifest versions. Valeur par défaut : false.

Ajoute le nouveau suffixe de version uniquement aux packages qui ont changé à partir d’une build précédente. Si aucune modification n’est trouvée, le suffixe de version de la build précédente est ajouté.

Notes

Par défaut, le compilateur crée des sorties différentes même si aucune modification n’a été apportée. Utilisez l’indicateur de compilateur déterministe pour vous assurer que les builds avec les mêmes entrées produisent les mêmes sorties.


pkgArtifactName - Nom de l’artefact de package
string. Optionnel. Utilisez quand updateType = Manifest versions && updateOnlyChanged = true.

Spécifie le nom de l’artefact contenant le package d’application à des fins de comparaison.


logAllChanges - Journaliser toutes les modifications
boolean. facultatif. Utilisez quand updateType = Manifest versions && updateOnlyChanged = true. Valeur par défaut : true.

Compare tous les fichiers de chaque package et journal si le fichier a été ajouté, supprimé ou si son contenu a été modifié. Sinon, cette valeur booléenne compare les fichiers d’un package uniquement jusqu’à ce que la première modification soit trouvée pour des performances plus rapides.


compareType - Comparer par rapport à
string. Optionnel. Utilisez quand updateType = Manifest versions && updateOnlyChanged = true. Valeurs autorisées : LastSuccessful (Dernière build réussie), Specific (Build spécifique). Valeur par défaut : LastSuccessful.

Spécifie s’il faut comparer avec la dernière build terminée et réussie ou par rapport à une build spécifique.


buildNumber - Numéro de build
string. Optionnel. Utilisez quand updateType = Manifest versions && compareType = Specific.

Spécifie le numéro de build à des fins de comparaison.


overwriteExistingPkgArtifact - Remplacer l’artefact de package existant
boolean. facultatif. Utilisez quand updateType = Manifest versions && updateOnlyChanged = true. Valeur par défaut : true.

Télécharge une nouvelle copie de l’artefact. Sinon, cette valeur booléenne utilise une copie existante le cas échéant.


imageNamesPath - Chemin d’accès aux noms d’images
string. Optionnel. Utilisez quand updateType = Docker image settings.

Spécifie le chemin d’accès à un fichier texte qui contient les noms des images Docker associées à l’application Service Fabric qui doivent être mises à jour avec des synthèses. Chaque nom d’image doit se trouver sur sa propre ligne et doit être dans le même ordre que les synthèses dans le fichier Image Digests. Si les images sont créées par le projet Service Fabric, ce fichier est généré dans le cadre de la cible package et son emplacement de sortie est contrôlé par la propriété BuiltDockerImagesFilePath.


imageDigestsPath - Chemin d’accès aux synthèses d’images
string. Obligatoire lorsque updateType = Docker image settings.

Spécifie le chemin d’accès à un fichier texte qui contient les valeurs digest des images Docker associées à l’application Service Fabric. Ce fichier peut être généré par la tâche Docker lors de l’utilisation de l’action push. Le fichier doit contenir des lignes de texte au format .registry/image_name@digest_value


Options de contrôle des tâches

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâche. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Aucun.

Notes

Utilisez cette tâche dans un pipeline de build pour mettre à jour automatiquement les versions d’une application Service Fabric empaquetée. Cette tâche ajoute un suffixe de version à toutes les versions de service et d’application, spécifiées dans les fichiers manifeste, dans un package d’application Azure Service Fabric.

Notes

Cette tâche nécessite Windows PowerShell.

Cette tâche n’est pas disponible dans les pipelines de mise en production .

Cette tâche peut uniquement être utilisée dans un pipeline de build pour mettre à jour automatiquement les versions d’une application Service Fabric empaquetée.

Cette tâche prend en charge deux types de mises à jour :

  1. Version du manifeste : Mises à jour versions de service et d’application spécifiées dans les fichiers manifeste dans un package d’application Service Fabric. S’il est spécifié, manifest version compare les fichiers actuels à une build précédente et met à jour la version uniquement pour ces services modifiés.

  2. Paramètres d’image Docker : Mises à jour paramètres d’image de conteneur Docker spécifiés dans les fichiers manifeste dans un package d’application Service Fabric. Les paramètres d’image à placer sont choisis à partir de deux fichiers :

    a. Fichier de noms d’images : ce fichier est généré par la tâche de génération.

    b. Fichier de synthèses d’images : ce fichier est généré par la tâche docker lorsqu’elle envoie des images au Registre.

Exemples

Spécifications

Condition requise Description
Types de pipelines YAML, build classique
S’exécute sur Agent, DeploymentGroup
Demandes Les agents auto-hébergés doivent avoir des fonctionnalités qui correspondent aux exigences suivantes pour exécuter des travaux qui utilisent cette tâche : Cmd
Capabilities Cette tâche ne répond à aucune demande pour les tâches suivantes dans le travail.
Restrictions de commande Quelconque
Variables paramétrables Quelconque
Version de l’agent 1.95.0 ou version ultérieure
Catégorie de la tâche Utilitaire