GitHubRelease@0 - Attività GitHub Release v0

Usare questa attività per creare, modificare o eliminare una versione di GitHub.

Sintassi

# 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" }].

Input

gitHubConnection - Connessione GitHub (OAuth o PAT)
string. Obbligatorio.

Specifica il nome della connessione al servizio GitHub da usare per connettersi al repository GitHub. La connessione deve essere basata su OAuth dell'utente di GitHub o su un token di accesso personale di GitHub. Per altre informazioni sulle connessioni al servizio, vedere Gestire le connessioni al servizio.

repositoryName - Repository
string. Obbligatorio. Valore predefinito: $(Build.Repository.Name).

Specifica il nome del repository GitHub in cui verrà creata, modificata o eliminata la versione di GitHub.

action - Azione
string. Obbligatorio. Valori consentiti: create, edit, delete. Valore predefinito: create.

Specifica il tipo di operazione di rilascio da eseguire. Questa attività può creare, modificare o eliminare una versione di GitHub.

target - Bersaglio
string. Obbligatorio quando action = create || action = edit. Valore predefinito: $(Build.SourceVersion).

Specifica lo SHA di commit che si vuole usare per creare la versione di GitHub, ad esempio 48b11d8d6e92a22e3e9563a3f643699c16fd6e27. È anche possibile usare una variabile, ad esempio $(myCommitSHA), in questo campo.

tagSource - Origine tag
string. Obbligatorio quando action = create. Valori consentiti: auto (tag Git), manual (tag specificato dall'utente). Valore predefinito: auto.

Specifica il tag che si vuole usare per la creazione della versione. L'opzione auto (tag Git) usa automaticamente il tag associato al commit Git. Usare l'opzione manual (Tag specificato dall'utente) per specificare manualmente un tag.

tagPattern - Modello di tag
string. facoltativo. Usare quando tagSource = auto.

Specifica il modello di tag Git usando regex, ad esempio release-v1.*. La versione di GitHub verrà creata solo per i commit con tag Git corrispondente.

tag - Tag
string. Obbligatorio quando action = edit || action = delete || tagSource = manual.

Specifica il tag che si vuole usare quando si crea, si modifica o si elimina una versione. È anche possibile usare una variabile, ad esempio $(myTagName), in questo campo.

title - Titolo della versione
string. facoltativo. Usare quando action = create || action = edit.

Specifica il titolo della versione di GitHub. Se lasciato vuoto, il tag verrà usato come titolo di rilascio.

releaseNotesSource - Origine note sulla versione
string. facoltativo. Usare quando action = create || action = edit. Valori consentiti: file (file note sulla versione), input (note sulla versione inline). Valore predefinito: file.

Specifica la descrizione della versione di GitHub. Usare l'opzione (File note sulla versione) per usare il file contenuto del file come note sulla versione. Usare l'opzione input (note sulla versione inline) per immettere manualmente le note sulla versione.

releaseNotesFile - Percorso file note sulla versione
string. facoltativo. Usare quando releaseNotesSource = file.

Specifica il file contenente le note sulla versione.

releaseNotes - Note sulla versione
string. facoltativo. Usare quando releaseNotesSource = input.

Specifica le note sulla versione. Markdown è supportato.

assets - Asset
string. facoltativo. Usare quando action = create || action = edit. Valore predefinito: $(Build.ArtifactStagingDirectory)/*.

Specifica i file da caricare come asset della versione. È possibile usare caratteri jolly per specificare più file. Ad esempio, usare $(Build.ArtifactStagingDirectory)/*.zip per le pipeline di compilazione o usare $(System.DefaultWorkingDirectory)/*.zip per le pipeline di rilascio.

È anche possibile specificare più modelli, uno per riga. Per impostazione predefinita, tutti i file nella $(Build.ArtifactStagingDirectory) directory verranno caricati. Per altre informazioni sull'elenco delle variabili predefinite disponibili, vedere Variabili di compilazione e variabili di rilascio.

assetUploadMode - Modalità di caricamento asset
string. facoltativo. Usare quando action = edit. Valori consentiti: delete (Eliminare gli asset esistenti), replace (Sostituire gli asset esistenti). Valore predefinito: delete.

Specifica la modalità di caricamento dell'asset da usare. Usare l'opzione delete (Elimina asset esistenti) per eliminare prima qualsiasi asset esistente nella versione e quindi caricare tutti gli asset. Usare l'opzione replace (Sostituisci asset esistenti) per sostituire eventuali asset con lo stesso nome.

isDraft - Versione bozza
boolean. facoltativo. Usare quando action = create || action = edit. Valore predefinito: false.

Indica se si vuole salvare la versione come bozza (non pubblicata). Se false, la versione verrà pubblicata.

isPreRelease - Versione preliminare
boolean. facoltativo. Usare quando action = create || action = edit. Valore predefinito: false.

Indica se si vuole contrassegnare la versione come versione preliminare.

addChangeLog - Aggiungere changelog
boolean. facoltativo. Usare quando action = create || action = edit. Valore predefinito: true.

Specifica se si vuole includere un changelog. Se impostato su true, verrà generato un elenco di modifiche (commit e problemi) tra la versione corrente e l'ultima versione pubblicata.

changeLogCompareToRelease - Confronto con
string. Obbligatorio quando addChangeLog = true. Valori consentiti: lastFullRelease (Ultima versione completa), lastNonDraftRelease (Ultima versione non bozza), lastNonDraftReleaseByTag (Ultima versione non bozza per tag). Valore predefinito: lastFullRelease.

Indica la versione da confrontare con per generare il log delle modifiche:

• lastFullRelease (Ultima versione completa): confronta la versione corrente con la versione non bozza più recente non contrassegnata come non definitive.
• lastNonDraftRelease (Ultima versione non bozza): confronta la versione corrente con la versione non bozza più recente.
• lastNonDraftReleaseByTag (Ultima versione non bozza per tag): confronta la versione corrente con l'ultima versione non bozza corrispondente al tag specificato. È anche possibile specificare un'espressione regolare anziché un tag esatto.

changeLogCompareToReleaseTag - Tag di rilascio
string. Obbligatorio quando changeLogCompareToRelease = lastNonDraftReleaseByTag && addChangeLog = true.

Specifica l'espressione regolare per il tag di versione. Una versione corrispondente a questo tag verrà usata come base per il calcolo del log delle modifiche.

changeLogType - Tipo di log delle modifiche
string. Obbligatorio quando addChangeLog = true. Valori consentiti: commitBased (basato su commit), issueBased (basato sul problema). Valore predefinito: commitBased.

Specifica il tipo di log delle modifiche. Un log delle modifiche può essere basato su commit o basato su problemi. Un log delle modifiche basato su commit elenca tutti i commit inclusi in una versione. Un log delle modifiche basato su problemi elenca tutti i problemi o le richieste pull incluse nella versione.

changeLogLabels - Categorie
string. facoltativo. Usare quando changeLogType = issueBased && addChangeLog = true. Valore predefinito: [{ "label" : "bug", "displayName" : "Bugs", "state" : "closed" }].

Classifica le modifiche in base all'etichetta associata al problema o alla richiesta pull. Per un'etichetta, è possibile menzionare il nome visualizzato per la categoria e lo stato del problema. Esempi di etichette includono: "[{ "label" : "bug", "displayName" : "Bugs", "state" : "closed" }]". Nei casi in cui una modifica contiene più etichette, la prima etichetta specificata ha la priorità. Lasciare vuoto questo campo per visualizzare un elenco semplice di problemi o richieste pull.

Opzioni di controllo delle attività

Tutte le attività dispongono di opzioni di controllo oltre ai relativi input attività. Per altre informazioni, vedere Opzioni di controllo e proprietà comuni delle attività.

Variabili di output

Nessuno.

Osservazioni

È disponibile una versione più recente di questa attività in GitHubRelease@1.

Requisiti

Requisito	Descrizione
Tipi di pipeline	YAML, build classica, versione classica
Viene eseguito in	Agente, DeploymentGroup
Richieste	Nessuno
Capabilities	Questa attività non soddisfa le richieste per le attività successive nel processo.
Restrizioni dei comandi	Qualsiasi
Variabili impostabili	Qualsiasi
Versione agente	2.0.0 o versione successiva
Categoria attività	Utilità