GitHubRelease@0 - Tâche GitHub Release v0

Utilisez cette tâche pour créer, modifier ou supprimer une version GitHub.

Cette version de la tâche est déconseillée ; utilisez GitHubRelease@1.

Utilisez cette tâche pour créer, modifier ou supprimer une version GitHub.

# GitHub Release v0
# Create, edit, or delete a GitHub release.
- task: GitHubRelease@0
  inputs:
    gitHubConnection: # string. Required. GitHub connection (OAuth or PAT). 
    repositoryName: '$(Build.Repository.Name)' # string. Required. Repository. Default: $(Build.Repository.Name).
    action: 'create' # 'create' | 'edit' | 'delete'. Required. Action. Default: create.
    #target: '$(Build.SourceVersion)' # string. Required when action = create || action = edit. Target. Default: $(Build.SourceVersion).
    tagSource: 'auto' # 'auto' | 'manual'. Required when action = create. Tag source. Default: auto.
    #tagPattern: # string. Optional. Use when tagSource = auto. Tag Pattern. 
    #tag: # string. Required when action = edit || action = delete || tagSource = manual. Tag. 
    #title: # string. Optional. Use when action = create || action = edit. Release title. 
    #releaseNotesSource: 'file' # 'file' | 'input'. Optional. Use when action = create || action = edit. Release notes source. Default: file.
    #releaseNotesFile: # string. Optional. Use when releaseNotesSource = file. Release notes file path. 
    #releaseNotes: # string. Optional. Use when releaseNotesSource = input. Release notes. 
    #assets: '$(Build.ArtifactStagingDirectory)/*' # string. Optional. Use when action = create || action = edit. Assets. Default: $(Build.ArtifactStagingDirectory)/*.
    #assetUploadMode: 'delete' # 'delete' | 'replace'. Optional. Use when action = edit. Asset upload mode. Default: delete.
    #isDraft: false # boolean. Optional. Use when action = create || action = edit. Draft release. Default: false.
    #isPreRelease: false # boolean. Optional. Use when action = create || action = edit. Pre-release. Default: false.
    #addChangeLog: true # boolean. Optional. Use when action = create || action = edit. Add changelog. Default: true.
  # Changelog configuration
    changeLogCompareToRelease: 'lastFullRelease' # 'lastFullRelease' | 'lastNonDraftRelease' | 'lastNonDraftReleaseByTag'. Required when addChangeLog = true. Compare to. Default: lastFullRelease.
    #changeLogCompareToReleaseTag: # string. Required when changeLogCompareToRelease = lastNonDraftReleaseByTag && addChangeLog = true. Release Tag. 
    changeLogType: 'commitBased' # 'commitBased' | 'issueBased'. Required when addChangeLog = true. Changelog type. Default: commitBased.
    #changeLogLabels: '[{ "label" : "bug", "displayName" : "Bugs", "state" : "closed" }]' # string. Optional. Use when changeLogType = issueBased && addChangeLog = true. Categories. Default: [{ "label" : "bug", "displayName" : "Bugs", "state" : "closed" }].

gitHubConnection - connexion GitHub (OAuth ou PAT)
string. Obligatoire.

Spécifie le nom de la connexion de service GitHub à utiliser pour se connecter au dépôt GitHub. La connexion doit être basée sur le jeton d’accès personnel OAuth d’un utilisateur GitHub ou gitHub. Pour plus d’informations sur les connexions de service, consultez Gérer les connexions de service.

repositoryName - référentiel
string. Obligatoire. Valeur par défaut : $(Build.Repository.Name).

Spécifie le nom du dépôt GitHub dans lequel vous allez créer, modifier ou supprimer la version GitHub.

action - action
string. Obligatoire. Valeurs autorisées : create, edit, delete. Valeur par défaut : create.

Spécifie le type d’opération de mise en production à effectuer. Cette tâche peut créer, modifier ou supprimer une version GitHub.

target - cible
string. Obligatoire lorsque action = create || action = edit. Valeur par défaut : $(Build.SourceVersion).

Spécifie la sha de validation que vous souhaitez utiliser pour créer la version GitHub, par exemple 48b11d8d6e92a22e3e9563a3f643699c16fd6e27. Vous pouvez également utiliser une variable, comme $(myCommitSHA), dans ce champ.

tagSource - balise source
string. Obligatoire lorsque action = create. Valeurs autorisées : auto (balise Git), manual (balise spécifiée par l’utilisateur). Valeur par défaut : auto.

Spécifie la balise que vous souhaitez utiliser pour la création de version. L’option auto (balise Git) utilise automatiquement la balise associée à la validation Git. Utilisez l’option manual (balise spécifiée par l’utilisateur) pour fournir manuellement une balise.

tagPattern - modèle d’étiquette
string. Optionnel. Utilisez quand tagSource = auto.

Spécifie le modèle d’étiquette Git à l’aide de regex, par exemple release-v1.*. La version gitHub sera créée uniquement pour les validations qui ont une balise Git correspondante.

tag - balise
string. Obligatoire lorsque action = edit || action = delete || tagSource = manual.

Spécifie la balise que vous souhaitez utiliser lorsque vous créez, modifiez ou supprimez une version. Vous pouvez également utiliser une variable, comme $(myTagName), dans ce champ.

title - titre de publication
string. Optionnel. Utilisez quand action = create || action = edit.

Spécifie le titre de la version GitHub. Si elle est vide, la balise sera utilisée comme titre de mise en production.

releaseNotesSource - la source des notes de publication
string. Optionnel. Utilisez quand action = create || action = edit. Valeurs autorisées : file (fichier notes de publication), input (notes de publication inline). Valeur par défaut : file.

Spécifie la description de la version GitHub. Utilisez l’option file (fichier notes de publication) pour utiliser le contenu du fichier comme notes de publication. Utilisez l’option input (notes de publication inline) pour entrer manuellement les notes de publication.

releaseNotesFile - chemin du fichier notes de publication
string. Optionnel. Utilisez quand releaseNotesSource = file.

Spécifie le fichier qui contient les notes de publication.

notes de publication releaseNotes -
string. Optionnel. Utilisez quand releaseNotesSource = input.

Spécifie les notes de publication. Markdown est pris en charge.

assets - ressources
string. Optionnel. Utilisez quand action = create || action = edit. Valeur par défaut : $(Build.ArtifactStagingDirectory)/*.

Spécifie les fichiers que vous souhaitez charger en tant que ressources de la version. Vous pouvez utiliser des caractères génériques pour spécifier plusieurs fichiers. Par exemple, utilisez $(Build.ArtifactStagingDirectory)/*.zip pour les pipelines de build ou utilisez $(System.DefaultWorkingDirectory)/*.zip pour les pipelines de mise en production.

Vous pouvez également spécifier plusieurs modèles, un par ligne. Par défaut, tous les fichiers du répertoire $(Build.ArtifactStagingDirectory) sont chargés. Pour plus d’informations sur la liste des variables prédéfinies disponibles, consultez variables de génération et variables de mise en production.

assetUploadMode - mode de chargement de ressource
string. Optionnel. Utilisez quand action = edit. Valeurs autorisées : delete (Supprimer les ressources en cours), replace (Remplacer les ressources existantes). Valeur par défaut : delete.

Spécifie le mode de chargement de ressource que vous souhaitez utiliser. Utilisez l’option delete (Supprimer les ressources existantes) pour supprimer d’abord les ressources existantes dans la version, puis charger toutes les ressources. Utilisez l’option replace (Remplacer les ressources existantes) pour remplacer les ressources portant le même nom.

isDraft - version préliminaire
boolean. Optionnel. Utilisez quand action = create || action = edit. Valeur par défaut : false.

Indique si vous souhaitez enregistrer la version en tant que brouillon (non publié). Si false, la version sera publiée.

isPreRelease - préversion
boolean. Optionnel. Utilisez quand action = create || action = edit. Valeur par défaut : false.

Indique si vous souhaitez marquer la version comme préversion.

addChangeLog - Ajouter un journal des modifications
boolean. Optionnel. Utilisez quand action = create || action = edit. Valeur par défaut : true.

Spécifie si vous souhaitez inclure un journal des modifications. Si la valeur est true, une liste de modifications (validations et problèmes) entre la version actuelle et la dernière version publiée est générée et ajoutée aux notes de publication.

comparaison changeLogCompareToRelease - à
string. Obligatoire lorsque addChangeLog = true. Valeurs autorisées : lastFullRelease (dernière version complète), lastNonDraftRelease (dernière version non préliminaire), lastNonDraftReleaseByTag (dernière version non préliminaire par balise). Valeur par défaut : lastFullRelease.

Indique la version à comparer avec laquelle générer le journal des modifications :

• lastFullRelease (dernière version complète) : compare la version actuelle avec la version non préliminaire la plus récente qui n’est pas marquée comme préversion.
• lastNonDraftRelease (dernière version non préliminaire) : compare la version actuelle à la version la plus récente.
• lastNonDraftReleaseByTag (dernière version non brouillon par balise) : compare la version actuelle avec la dernière version non brouillon correspondant à la balise spécifiée. Vous pouvez également spécifier un regex au lieu d’une balise exacte.

changeLogCompareToReleaseTag - de la balise de mise en production
string. Obligatoire lorsque changeLogCompareToRelease = lastNonDraftReleaseByTag && addChangeLog = true.

Spécifie le regex de la balise de mise en production. Une mise en production correspondant à cette balise sera utilisée comme base pour le calcul du journal des modifications.

changeLogType - type Changelog
string. Obligatoire lorsque addChangeLog = true. Valeurs autorisées : commitBased (basé sur la validation), issueBased (basé sur le problème). Valeur par défaut : commitBased.

Spécifie le type de journal des modifications. Un journal des modifications peut être basé sur une validation ou un problème. Un journal des modifications basé sur la validation répertorie toutes les validations incluses dans une version. Un journal des modifications basé sur un problème répertorie tous les problèmes ou demandes de tirage (PULL) inclus dans la version.

catégories changeLogLabels -
string. Optionnel. Utilisez quand changeLogType = issueBased && addChangeLog = true. Valeur par défaut : [{ "label" : "bug", "displayName" : "Bugs", "state" : "closed" }].

Classe les modifications en fonction de l’étiquette associée au problème ou à la demande de tirage. Pour une étiquette, vous pouvez mentionner le nom complet de la catégorie et l’état du problème. Voici quelques exemples d’étiquettes : "[{ "label" : "bug", "displayName" : "Bugs", "state" : "closed" }]". Dans les cas où une modification comporte plusieurs étiquettes, la première étiquette spécifiée est prioritaire. Laissez ce champ vide pour afficher une liste plate de problèmes ou de demandes de tirage.

Aucun.

Remarques

Il existe une version plus récente de cette tâche disponible à GitHubRelease@1.