GitHubRelease@0 — zadanie wydania usługi GitHub w wersji 0

To zadanie służy do tworzenia, edytowania lub usuwania wydania usługi GitHub.

Ta wersja zadania jest przestarzała; użyj GitHubRelease@1.

Składnia

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

Dane wejściowe

gitHubConnection - połączenia GitHub (OAuth lub PAT)
string. To jest wymagane.

Określa nazwę połączenia usługi GitHub, które ma być używane do łączenia się z repozytorium GitHub. Połączenie musi być oparte na protokole OAuth użytkownika usługi GitHub lub osobistym tokenie dostępu usługi GitHub. Aby uzyskać więcej informacji na temat połączeń usług, zobacz Zarządzanie połączeniami usług.

repozytorium repositoryName -
string. To jest wymagane. Wartość domyślna: $(Build.Repository.Name).

Określa nazwę repozytorium GitHub, w którym utworzysz, edytujesz lub usuniesz wydanie usługi GitHub.

action - akcja
string. To jest wymagane. Dozwolone wartości: create, edit, delete. Wartość domyślna: create.

Określa typ operacji wydania do wykonania. To zadanie może tworzyć, edytować lub usuwać wydanie usługi GitHub.

target - target
string. Wymagane, gdy action = create || action = edit. Wartość domyślna: $(Build.SourceVersion).

Określa zatwierdzony algorytm SHA, którego chcesz użyć do utworzenia wydania usługi GitHub, na przykład 48b11d8d6e92a22e3e9563a3f643699c16fd6e27. Możesz również użyć zmiennej, takiej jak $(myCommitSHA), w tym polu.

źródła tagów tagSource -
string. Wymagane, gdy action = create. Dozwolone wartości: auto (tag Git), manual (tag określony przez użytkownika). Wartość domyślna: auto.

Określa tag, którego chcesz użyć do tworzenia wydania. Opcja auto (tag Usługi Git) automatycznie używa tagu skojarzonego z zatwierdzeniem usługi Git. Użyj opcji manual (tag określony przez użytkownika), aby ręcznie podać tag.

tagPattern - wzorzec tagu
string. Opcjonalny. Użyj polecenia , gdy tagSource = auto.

Określa wzorzec tagu Git przy użyciu wyrażenia regularnego, na przykład release-v1.*. Wydanie usługi GitHub zostanie utworzone tylko dla zatwierdzeń, które mają pasujący tag Git.

tagów
string. Wymagane, gdy action = edit || action = delete || tagSource = manual.

Określa tag, którego chcesz użyć podczas tworzenia, edytowania lub usuwania wydania. Możesz również użyć zmiennej, takiej jak $(myTagName), w tym polu.

tytuł wydania title -
string. Opcjonalny. Użyj polecenia , gdy action = create || action = edit.

Określa tytuł wydania usługi GitHub. Jeśli pole pozostanie puste, tag będzie używany jako tytuł wydania.

releaseNotesSource - źródła informacji o wersji
string. Opcjonalny. Użyj polecenia , gdy action = create || action = edit. Dozwolone wartości: file (plik informacji o wersji), input (informacje o wersji wbudowanej). Wartość domyślna: file.

Określa opis wydania usługi GitHub. Użyj opcji file (plik informacji o wersji), aby użyć zawartości pliku jako informacji o wersji. Użyj opcji input (informacje o wersji wbudowanej), aby ręcznie wprowadzić informacje o wersji.

releaseNotesFile - ścieżka pliku informacji o wersji
string. Opcjonalny. Użyj polecenia , gdy releaseNotesSource = file.

Określa plik zawierający informacje o wersji.

informacje o wersji releaseNotes -
string. Opcjonalny. Użyj polecenia , gdy releaseNotesSource = input.

Określa informacje o wersji. Język Markdown jest obsługiwany.

assets - zasoby
string. Opcjonalny. Użyj polecenia , gdy action = create || action = edit. Wartość domyślna: $(Build.ArtifactStagingDirectory)/*.

Określa pliki, które chcesz przekazać jako zasoby wydania. Możesz użyć symboli wieloznacznych, aby określić wiele plików. Na przykład użyj $(Build.ArtifactStagingDirectory)/*.zip dla potoków kompilacji lub użyj $(System.DefaultWorkingDirectory)/*.zip dla potoków wydania.

Można również określić wiele wzorców, po jednym na wiersz. Domyślnie wszystkie pliki w katalogu $(Build.ArtifactStagingDirectory) zostaną przekazane. Aby uzyskać więcej informacji na temat listy wstępnie zdefiniowanych zmiennych, zobacz zmiennych kompilacji i zmiennych wydania .

assetUploadMode - tryb przekazywania zasobów
string. Opcjonalny. Użyj polecenia , gdy action = edit. Dozwolone wartości: delete (Usuń zasoby exisiting), replace (Zastąp istniejące zasoby). Wartość domyślna: delete.

Określa tryb przekazywania zasobów, którego chcesz użyć. Użyj opcji delete (Usuń istniejące zasoby), aby najpierw usunąć wszystkie istniejące zasoby w wydaniu, a następnie przekazać wszystkie zasoby. Użyj opcji replace (Zastąp istniejące zasoby), aby zastąpić wszystkie zasoby o tej samej nazwie.

isDraft - wersji roboczej
boolean. Opcjonalny. Użyj polecenia , gdy action = create || action = edit. Wartość domyślna: false.

Wskazuje, czy chcesz zapisać wydanie jako wersję roboczą (cofnięto publikowanie). Jeśli false, wydanie zostanie opublikowane.

wersji wstępnej isPreRelease -
boolean. Opcjonalny. Użyj polecenia , gdy action = create || action = edit. Wartość domyślna: false.

Wskazuje, czy chcesz oznaczyć wydanie jako wydanie wstępne.

addChangeLog - Dodaj dziennik zmian
boolean. Opcjonalny. Użyj polecenia , gdy action = create || action = edit. Wartość domyślna: true.

Określa, czy chcesz dołączyć dziennik zmian. W przypadku ustawienia wartości truelista zmian (zatwierdzeń i problemów) między bieżącą wersją a ostatnią opublikowaną wersją zostanie wygenerowana i dołączona do informacji o wersji.

changeLogCompareToRelease - Porównanie z
string. Wymagane, gdy addChangeLog = true. Dozwolone wartości: lastFullRelease (ostatnia pełna wersja), lastNonDraftRelease (ostatnia wersja niezwiązana z wersją roboczą), lastNonDraftReleaseByTag (Ostatnie wydanie nie wersji roboczej według tagu). Wartość domyślna: lastFullRelease.

Wskazuje, z którą wersją ma być porównywana, aby wygenerować dziennik zmian:

• lastFullRelease (ostatnia pełna wersja): porównuje bieżącą wersję z najnowszą wersją inną niż wersja robocza, która nie jest oznaczona jako wersja wstępna.
• lastNonDraftRelease (ostatnia wersja niezwiązana z wersją roboczą): porównuje bieżącą wersję z najnowszą wersją inną niż wersja robocza.
• lastNonDraftReleaseByTag (ostatnie wydanie inne niż wersja robocza według tagu): porównuje bieżącą wersję z ostatnim wydaniem nienależącym do wersji roboczej pasującej do określonego tagu. Można również określić wyrażenie regularne zamiast dokładnego tagu.

changeLogCompareToReleaseTag - tagu wydania
string. Wymagane, gdy changeLogCompareToRelease = lastNonDraftReleaseByTag && addChangeLog = true.

Określa wyrażenie regularne dla tagu wydania. Wersja zgodna z tym tagiem będzie używana jako podstawa obliczeń dziennika zmian.

changeLogType - typ dziennika zmian
string. Wymagane, gdy addChangeLog = true. Dozwolone wartości: commitBased (na podstawie zatwierdzenia), issueBased (na podstawie problemu). Wartość domyślna: commitBased.

Określa typ dziennika zmian. Dziennik zmian może być oparty na zatwierdzeniach lub oparty na problemach. Dziennik zmian oparty na zatwierdzeniach zawiera listę wszystkich zatwierdzeń uwzględnionych w wydaniu. Dziennik zmian oparty na problemach zawiera listę wszystkich problemów lub żądań ściągnięcia uwzględnionych w wydaniu.

kategorii changeLogLabels -
string. Opcjonalny. Użyj polecenia , gdy changeLogType = issueBased && addChangeLog = true. Wartość domyślna: [{ "label" : "bug", "displayName" : "Bugs", "state" : "closed" }].

Kategoryzuje zmiany na podstawie etykiety skojarzonej z problemem lub żądaniem ściągnięcia. W przypadku etykiety możesz wspomnieć o nazwie wyświetlanej kategorii i stanie problemu. Przykłady etykiet to: "[{ "label" : "bug", "displayName" : "Bugs", "state" : "closed" }]". W przypadkach, gdy zmiana zawiera wiele etykiet, pierwsza określona etykieta ma priorytet. Pozostaw to pole puste, aby wyświetlić płaską listę problemów lub żądania ściągnięcia.

Opcje sterowania zadaniami

Wszystkie zadania mają opcje sterowania oprócz danych wejściowych zadań podrzędnych. Aby uzyskać więcej informacji, zobacz opcje kontroli i typowe właściwości zadań.

Zmienne wyjściowe

Żaden.

Uwagi

W GitHubRelease@1jest dostępna nowsza wersja tego zadania.

Wymagania

Wymaganie	Opis
Typy potoków	YAML, klasyczna kompilacja, wersja klasyczna
Działa na	Agent, DeploymentGroup
Wymagania	Żaden
możliwości	To zadanie nie spełnia żadnych wymagań dotyczących kolejnych zadań w zadaniu.
ograniczenia poleceń	Jakikolwiek
zmienne ustawiane	Jakikolwiek
Wersja agenta	2.0.0 lub nowsza
Kategoria zadań	Użyteczność