GitHubRelease@0 – úloha GitHub Release v0

Pomocí této úlohy můžete vytvořit, upravit nebo odstranit verzi GitHubu.

Syntax

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

Vstupy

gitHubConnection - Připojení Ke GitHubu (OAuth nebo PAT)
string. Povinná hodnota.

Určuje název připojení služby GitHub, které se má použít pro připojení k úložišti GitHub. Připojení musí být založené na OAuth uživatele GitHubu nebo na osobním přístupovém tokenu GitHubu. Další informace o připojeních služeb najdete v tématu Správa připojení služeb.

repositoryName - Úložiště
string. Povinná hodnota. Výchozí hodnota: $(Build.Repository.Name).

Určuje název úložiště GitHub, ve kterém vytvoříte, upravíte nebo odstraníte verzi GitHubu.

action - Akce
string. Povinná hodnota. Povolené hodnoty: create, edit, delete. Výchozí hodnota: create.

Určuje typ operace uvolnění, která se má provést. Tato úloha může vytvořit, upravit nebo odstranit verzi GitHubu.

target - Cíl
string. Vyžaduje se, když action = create || action = edit. Výchozí hodnota: $(Build.SourceVersion).

Určuje algoritmus SHA potvrzení, který chcete použít k vytvoření verze GitHubu, například 48b11d8d6e92a22e3e9563a3f643699c16fd6e27. V tomto poli můžete použít také proměnnou, například $(myCommitSHA).

tagSource - Zdroj značky
string. Vyžaduje se, když action = create. Povolené hodnoty: auto (značka Git), manual (značka zadaná uživatelem). Výchozí hodnota: auto.

Určuje značku, kterou chcete použít k vytvoření verze. Možnost auto (značka Gitu) automaticky použije značku, která je přidružená k potvrzení Gitu. K ručnímu manual zadání značky použijte možnost (značka zadaná uživatelem).

tagPattern - Vzor značek
string. Nepovinný parametr. Použijte, když tagSource = auto.

Určuje vzor značky Git pomocí regulárního výrazu, například release-v1.*. Verze GitHubu se vytvoří jenom pro potvrzení, která mají odpovídající značku Gitu.

tag - Značku
string. Vyžaduje se, když action = edit || action = delete || tagSource = manual.

Určuje značku, kterou chcete použít při vytváření, úpravách nebo odstraňování vydané verze. V tomto poli můžete použít také proměnnou, například $(myTagName).

title - Název vydané verze
string. Nepovinný parametr. Použijte, když action = create || action = edit.

Určuje název verze GitHubu. Pokud je tato značka prázdná, použije se jako název verze.

releaseNotesSource - Zdroj zpráv k vydání verze
string. Nepovinný parametr. Použijte, když action = create || action = edit. Povolené hodnoty: file (soubor zpráv k vydání verze), input (vložené poznámky k verzi). Výchozí hodnota: file.

Určuje popis verze GitHubu. Pokud chcete jako poznámky k file verzi použít obsah souboru, použijte možnost (soubor zpráv k vydání verze). input Pomocí možnosti (vložené poznámky k verzi) můžete ručně zadat poznámky k verzi.

releaseNotesFile - Cesta k souboru poznámek k verzi
string. Nepovinný parametr. Použijte, když releaseNotesSource = file.

Určuje soubor, který obsahuje poznámky k verzi.

releaseNotes - Poznámky
string. Nepovinný parametr. Použijte, když releaseNotesSource = input.

Určuje poznámky k verzi. Markdown je podporovaný.

assets - Aktiv
string. Nepovinný parametr. Použijte, když action = create || action = edit. Výchozí hodnota: $(Build.ArtifactStagingDirectory)/*.

Určuje soubory, které chcete nahrát jako prostředky vydané verze. K určení více souborů můžete použít zástupné znaky. Můžete například použít $(Build.ArtifactStagingDirectory)/*.zip pro kanály buildu nebo pro $(System.DefaultWorkingDirectory)/*.zip kanály verze.

Můžete také zadat více vzorů, jeden na řádek. Ve výchozím nastavení se nahrají všechny soubory v adresáři $(Build.ArtifactStagingDirectory) . Další informace o seznamu předdefinovaných proměnných, které jsou k dispozici, najdete v tématu Proměnné sestavení a proměnné verze.

assetUploadMode - Režim nahrávání prostředků
string. Nepovinný parametr. Použijte, když action = edit. Povolené hodnoty: delete (Odstranit existující prostředky), replace (Nahradit existující prostředky). Výchozí hodnota: delete.

Určuje režim nahrávání prostředků, který chcete použít. delete Pomocí možnosti (Odstranit existující prostředky) nejprve odstraňte všechny existující prostředky ve vydané verzi a pak nahrajte všechny prostředky. replace Pomocí možnosti (Nahradit existující prostředky) můžete nahradit všechny prostředky, které mají stejný název.

isDraft - Verze konceptu
boolean. Nepovinný parametr. Použijte, když action = create || action = edit. Výchozí hodnota: false.

Určuje, jestli chcete verzi uložit jako koncept (nepublikované). Pokud false, bude vydaná verze publikovaná.

isPreRelease - Předběžná verze
boolean. Nepovinný parametr. Použijte, když action = create || action = edit. Výchozí hodnota: false.

Určuje, jestli chcete verzi označit jako předběžnou verzi.

addChangeLog - Přidání protokolu změn
boolean. Nepovinný parametr. Použijte, když action = create || action = edit. Výchozí hodnota: true.

Určuje, jestli chcete zahrnout protokol změn. Pokud je nastavená hodnota true, vygeneruje se seznam změn (potvrzení a problémů) mezi aktuální a poslední publikovanou verzí a připojí se k poznámkám k verzi.

changeLogCompareToRelease - Porovnat s
string. Vyžaduje se, když addChangeLog = true. Povolené hodnoty: lastFullRelease (Poslední úplná verze), lastNonDraftRelease (Poslední vydání bez konceptu) lastNonDraftReleaseByTag (Poslední vydání bez konceptu podle značky). Výchozí hodnota: lastFullRelease.

Určuje, s jakou verzí se má porovnat, aby se vygeneroval protokol změn:

• lastFullRelease (Poslední úplná verze): Porovná aktuální verzi s nejnovější verzí bez konceptu, která není označená jako předběžná verze.
• lastNonDraftRelease (Poslední verze, která není konceptem): Porovná aktuální verzi s nejnovější verzí, která není konceptem.
• lastNonDraftReleaseByTag (Poslední verze, která není konceptem podle značky): Porovná aktuální verzi s poslední verzí, která není koncept, která odpovídá zadané značce. Můžete také zadat regex místo přesné značky.

changeLogCompareToReleaseTag - Značka release
string. Vyžaduje se, když changeLogCompareToRelease = lastNonDraftReleaseByTag && addChangeLog = true.

Určuje regex pro značku vydané verze. Verze odpovídající této značce se použije jako základ pro výpočet protokolu změn.

changeLogType - Typ protokolu změn
string. Vyžaduje se, když addChangeLog = true. Povolené hodnoty: commitBased (na základě potvrzení) issueBased (na základě problému). Výchozí hodnota: commitBased.

Určuje typ protokolu změn. Protokol změn může být založený na potvrzení nebo na základě problémů. Protokol změn založený na potvrzení obsahuje seznam všech potvrzení zahrnutých ve vydané verzi. Protokol změn založený na problémech obsahuje seznam všech problémů nebo žádostí o přijetí změn zahrnutých ve vydané verzi.

changeLogLabels - Kategorie
string. Nepovinný parametr. Použijte, když changeLogType = issueBased && addChangeLog = true. Výchozí hodnota: [{ "label" : "bug", "displayName" : "Bugs", "state" : "closed" }].

Kategorizuje změny na základě popisku přidruženého k problému nebo žádosti o přijetí změn. U popisku můžete uvést zobrazovaný název kategorie a stav problému. Mezi příklady popisků patří: "[{ "label" : "bug", "displayName" : "Bugs", "state" : "closed" }]". V případech, kdy má změna více popisků, má prioritu první zadaný popisek. Pokud chcete zobrazit plochý seznam problémů nebo žádostí o přijetí změn, ponechte toto pole prázdné.

Možnosti ovládání úloh

Všechny úlohy mají kromě vstupů také možnosti ovládání. Další informace najdete v tématu Možnosti ovládacího prvku a běžné vlastnosti úlohy.

Výstupní proměnné

Žádné

Poznámky

Na GitHubRelease@1 je k dispozici novější verze této úlohy.

Požadavky

Požadavek	Popis
Typy kanálů	YAML, classic build, verze Classic
Spustí se	Agent, DeploymentGroup
Požadavky	Žádné
Možnosti	Tento úkol nesplňuje žádné požadavky na následné úkoly v úloze.
Omezení příkazů	Všechny
Nastavitelné proměnné	Všechny
Verze agenta	2.0.0 nebo vyšší
Kategorie úloh	Nástroj