GitHubRelease@0 – GitHub Release v0 feladat

Ezzel a feladatsal gitHub-kiadást hozhat létre, szerkeszthet vagy törölhet.

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

Bevitelek

gitHubConnection - GitHub-kapcsolat (OAuth vagy PAT)
string. Kötelező.

Megadja a GitHub-tárházhoz való csatlakozáshoz használandó GitHub-szolgáltatáskapcsolat nevét. A kapcsolatnak egy GitHub-felhasználó OAuth-ján vagy egy Személyes GitHub-hozzáférési jogkivonaton kell alapulnia. További információ a szolgáltatáskapcsolatokról: Szolgáltatáskapcsolatok kezelése.

repositoryName - Tárház
string. Kötelező. Alapértelmezett érték: $(Build.Repository.Name).

Megadja annak a GitHub-adattárnak a nevét, ahol létrehozza, szerkessze vagy törli a GitHub-kiadást.

action - Akció
string. Kötelező. Engedélyezett értékek: create, edit, delete. Alapértelmezett érték: create.

Megadja a végrehajtandó kiadási művelet típusát. Ez a feladat létrehozhat, szerkeszthet vagy törölhet Egy GitHub-kiadást.

target - Cél
string. Akkor szükséges, ha action = create || action = edit. Alapértelmezett érték: $(Build.SourceVersion).

A GitHub-kiadás létrehozásához használni kívánt véglegesítési SHA-t adja meg, például 48b11d8d6e92a22e3e9563a3f643699c16fd6e27: . Ebben a mezőben egy változót is használhat, például $(myCommitSHA): .

tagSource - Címke forrása
string. Akkor szükséges, ha action = create. Engedélyezett értékek: auto (Git-címke) manual (Felhasználó által megadott címke). Alapértelmezett érték: auto.

Megadja a kiadás létrehozásához használni kívánt címkét. A auto (Git-címke) beállítás automatikusan a Git-véglegesítéshez társított címkét használja. manual A (Felhasználó által megadott címke) beállítással manuálisan adhat meg címkét.

tagPattern - Címkeminta
string. Választható. Használja a következőt: tagSource = auto.

A Git-címke mintáját adja meg például release-v1.*regex használatával. A GitHub-kiadás csak olyan véglegesítésekhez jön létre, amelyek rendelkeznek egyező Git-címkével.

tag - Tag
string. Akkor szükséges, ha action = edit || action = delete || tagSource = manual.

Megadja a kiadás létrehozásakor, szerkesztésekor vagy törlésekor használni kívánt címkét. Ebben a mezőben egy változót is használhat, például $(myTagName): .

title - Kiadás címe
string. Választható. Használja a következőt: action = create || action = edit.

Megadja a GitHub-kiadás címét. Ha üresen hagyja, a címke lesz a kiadás címe.

releaseNotesSource - Kibocsátási megjegyzések forrása
string. Választható. Használja a következőt: action = create || action = edit. Engedélyezett értékek: file (Kibocsátási megjegyzések fájlja), input (beágyazott kibocsátási megjegyzések). Alapértelmezett érték: file.

Megadja a GitHub-kiadás leírását. file A (Kibocsátási megjegyzések fájl) beállítással a fájltartalmakat kibocsátási megjegyzésekként használhatja. input A (Beágyazott kibocsátási megjegyzések) lehetőséggel manuálisan adhat meg kibocsátási megjegyzéseket.

releaseNotesFile - Kibocsátási megjegyzések fájlelérési útja
string. Választható. Használja a következőt: releaseNotesSource = file.

Megadja a kibocsátási megjegyzéseket tartalmazó fájlt.

releaseNotes - Kibocsátási megjegyzések
string. Választható. Használja a következőt: releaseNotesSource = input.

Megadja a kibocsátási megjegyzéseket. A Markdown támogatott.

assets - Eszközök
string. Választható. Használja a következőt: action = create || action = edit. Alapértelmezett érték: $(Build.ArtifactStagingDirectory)/*.

A kiadás eszközeiként feltölteni kívánt fájlokat adja meg. Több fájl megadásához használhat helyettesítő karaktereket. Használhatja például $(Build.ArtifactStagingDirectory)/*.zip buildfolyamatokhoz vagy $(System.DefaultWorkingDirectory)/*.zip kiadási folyamatokhoz.

Több mintát is megadhat, soronként egyet. Alapértelmezés szerint a $(Build.ArtifactStagingDirectory) könyvtárban lévő összes fájl fel lesz töltve. Az elérhető előre definiált változók listájáról további információt a Változók összeállítása és a kiadási változók című témakörben talál.

assetUploadMode - Eszköz feltöltési módja
string. Választható. Használja a következőt: action = edit. Engedélyezett értékek: delete (Exisiting assets törlése), replace (Meglévő objektumok cseréje). Alapértelmezett érték: delete.

Megadja a használni kívánt eszközfeltöltési módot. delete A (Meglévő objektumok törlése) lehetőséggel először törölje a kiadásban lévő meglévő objektumokat, majd töltse fel az összes eszközt. replace A (Meglévő eszközök cseréje) lehetőséggel lecserélheti az azonos nevű eszközöket.

isDraft - Piszkozatkiadás
boolean. Választható. Használja a következőt: action = create || action = edit. Alapértelmezett érték: false.

Azt jelzi, hogy piszkozatként szeretné-e menteni a kiadást (közzé nem adhatja). Ha false, a kiadás közzé lesz téve.

isPreRelease - Előzetes kiadás
boolean. Választható. Használja a következőt: action = create || action = edit. Alapértelmezett érték: false.

Azt jelzi, hogy a kiadást előzetes kiadásként szeretné-e megjelölni.

addChangeLog - Változásnapló hozzáadása
boolean. Választható. Használja a következőt: action = create || action = edit. Alapértelmezett érték: true.

Itt adhatja meg, hogy szeretne-e változásnaplót felvenni. Ha a értékre truevan állítva, a rendszer létrehozza és hozzáfűzi a kibocsátási megjegyzésekhez az aktuális kiadás és az utolsó közzétett kiadás közötti módosításokat (véglegesítéseket és problémákat).

changeLogCompareToRelease - Összehasonlítás
string. Akkor szükséges, ha addChangeLog = true. Engedélyezett értékek: lastFullRelease (Utolsó teljes kiadás), lastNonDraftRelease (Utolsó, nem piszkozatos kiadás), lastNonDraftReleaseByTag (Utolsó nem piszkozatos kiadás címke szerint). Alapértelmezett érték: lastFullRelease.

Azt jelzi, hogy melyik kiadással kell összehasonlítani a változásnapló létrehozásához:

• lastFullRelease (Utolsó teljes kiadás): Összehasonlítja az aktuális kiadást a legújabb, nem piszkozatos kiadással, amely nincs előzetes kiadásként megjelölve.
• lastNonDraftRelease (Utolsó nem piszkozatos kiadás): Összehasonlítja az aktuális kiadást a legújabb, nem piszkozatos kiadással.
• lastNonDraftReleaseByTag (Utolsó nem piszkozati kiadás címke szerint): Összehasonlítja az aktuális kiadást a megadott címkével egyező utolsó, nem piszkozatos kiadással. Pontos címke helyett regexet is megadhat.

changeLogCompareToReleaseTag - Kiadási címke
string. Akkor szükséges, ha changeLogCompareToRelease = lastNonDraftReleaseByTag && addChangeLog = true.

A kiadási címke regexjét adja meg. A változásnapló-számítás alapjaként egy, a címkének megfelelő kiadást használunk.

changeLogType - Változásnapló típusa
string. Akkor szükséges, ha addChangeLog = true. Engedélyezett értékek: commitBased (Véglegesítésalapú), issueBased (Problémaalapú). Alapértelmezett érték: commitBased.

A változásnapló típusát adja meg. A változásnaplók véglegesítésen vagy problémaalapúak lehetnek. A véglegesítésalapú változásnapló a kiadásban szereplő összes véglegesítést felsorolja. A problémaalapú változásnapló felsorolja a kiadásban szereplő összes problémát vagy lekéréses kérelmet (PRS).

changeLogLabels - Kategóriák
string. Választható. Használja a következőt: changeLogType = issueBased && addChangeLog = true. Alapértelmezett érték: [{ "label" : "bug", "displayName" : "Bugs", "state" : "closed" }].

Kategorizálja a módosításokat a problémához vagy pr-hez társított címke alapján. Címke esetén megemlítheti a kategória megjelenítendő nevét és a probléma állapotát. A címkék például a következők: "[{ "label" : "bug", "displayName" : "Bugs", "state" : "closed" }]". Azokban az esetekben, amikor egy módosítás több címkével is rendelkezik, az első megadott címke elsőbbséget élvez. Hagyja üresen ezt a mezőt a problémák vagy a kérelmek egybesimított listájának megtekintéséhez.

Feladatvezérlési lehetőségek

Minden feladathoz tartoznak vezérlési lehetőségek is a feladat bemenetei mellett. További információ: Vezérlési beállítások és gyakori feladattulajdonságok.

Kimeneti változók

Nincsenek.

Megjegyzések

A feladat egy újabb verziója érhető el a GitHubRelease@1.

Követelmények

Követelmény	Leírás
Folyamattípusok	YAML, klasszikus build, klasszikus kiadás
Futtatás	Ügynök, DeploymentGroup
Igények	None
Képességek	Ez a feladat nem felel meg a feladat későbbi tevékenységeire vonatkozó követelményeknek.
Parancskorlátozások	Bármelyik
Változók beállítása	Bármelyik
Ügynök verziója	2.0.0 vagy újabb
Feladatkategória	Segédprogram