tarefa GitHubRelease@0 – GitHub Release v0

Use esta tarefa para criar, editar ou excluir uma versão do GitHub.

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

Entradas

gitHubConnection - Conexão do GitHub (OAuth ou PAT)
string. Obrigatórios.

Especifica o nome da conexão de serviço do GitHub a ser usada para se conectar ao repositório GitHub. A conexão deve ser baseada no OAuth de um usuário do GitHub ou em um token de acesso pessoal do GitHub. Para obter mais informações sobre conexões de serviço, consulte Gerenciar conexões de serviço.

repositoryName - Repositório
string. Obrigatórios. Valor padrão: $(Build.Repository.Name).

Especifica o nome do repositório GitHub em que você criará, editará ou excluirá a versão do GitHub.

action - Ação
string. Obrigatórios. Valores permitidos: create, edit, delete. Valor padrão: create.

Especifica o tipo de operação de versão a ser executada. Essa tarefa pode criar, editar ou excluir uma versão do GitHub.

target - Alvo
string. Obrigatório quando action = create || action = edit. Valor padrão: $(Build.SourceVersion).

Especifica o SHA de commit que você deseja usar para criar a versão do GitHub, por exemplo 48b11d8d6e92a22e3e9563a3f643699c16fd6e27. Você também pode usar uma variável, como $(myCommitSHA), neste campo.

tagSource - Origem da marca
string. Obrigatório quando action = create. Valores permitidos: auto (marca Git) manual (Marca especificada pelo usuário). Valor padrão: auto.

Especifica a marca que você deseja usar para a criação da versão. A auto opção (marca Git) usa automaticamente a marca associada ao commit do Git. Use a opção manual (Marca especificada pelo usuário) para fornecer manualmente uma marca.

tagPattern - Padrão de marca
string. Opcional. Use quando tagSource = auto.

Especifica o padrão de marca git usando regex, por exemplo release-v1.*. A versão do GitHub será criada somente para commits que tenham uma marca Git correspondente.

tag - Tag
string. Obrigatório quando action = edit || action = delete || tagSource = manual.

Especifica a marca que você deseja usar ao criar, editar ou excluir uma versão. Você também pode usar uma variável, como $(myTagName), neste campo.

title - Título da versão
string. Opcional. Use quando action = create || action = edit.

Especifica o título da versão do GitHub. Se deixado vazio, a marca será usada como o título da versão.

releaseNotesSource - Fonte de notas sobre a versão
string. Opcional. Use quando action = create || action = edit. Valores permitidos: file (arquivo notas de versão) input (notas de versão embutidas). Valor padrão: file.

Especifica a descrição da versão do GitHub. Use a opção file (Arquivo de notas de versão) para usar o conteúdo do arquivo como notas de versão. Use a opção input (notas de versão embutidas) para inserir manualmente as notas de versão.

releaseNotesFile - Caminho do arquivo de notas de versão
string. Opcional. Use quando releaseNotesSource = file.

Especifica o arquivo que contém as notas de versão.

releaseNotes - Notas sobre a versão
string. Opcional. Use quando releaseNotesSource = input.

Especifica as notas de versão. Há suporte para Markdown.

assets - Ativos
string. Opcional. Use quando action = create || action = edit. Valor padrão: $(Build.ArtifactStagingDirectory)/*.

Especifica os arquivos que você deseja carregar como ativos da versão. Você pode usar caracteres curinga para especificar vários arquivos. Por exemplo, use $(Build.ArtifactStagingDirectory)/*.zip para pipelines de build ou para pipelines $(System.DefaultWorkingDirectory)/*.zip de lançamento.

Você também pode especificar vários padrões, um por linha. Por padrão, todos os arquivos no diretório $(Build.ArtifactStagingDirectory) serão carregados. Para obter mais informações sobre a lista de variáveis predefinidas disponíveis, consulte variáveis de build e variáveis de versão.

assetUploadMode - Modo de carregamento de ativos
string. Opcional. Use quando action = edit. Valores permitidos: delete (Excluir ativos de exisiting) replace (Substituir ativos existentes). Valor padrão: delete.

Especifica o modo de carregamento de ativos que você deseja usar. Use a opção delete (Excluir ativos existentes) para primeiro excluir todos os ativos existentes na versão e, em seguida, carregar todos os ativos. Use a opção replace (Substituir ativos existentes) para substituir todos os ativos que tenham o mesmo nome.

isDraft - Versão de rascunho
boolean. Opcional. Use quando action = create || action = edit. Valor padrão: false.

Indica se você deseja salvar a versão como um rascunho (não publicado). Se false, a versão será publicada.

isPreRelease - Pré-lançamento
boolean. Opcional. Use quando action = create || action = edit. Valor padrão: false.

Indica se você deseja marcar a versão como uma pré-lançamento.

addChangeLog - Adicionar o changelog
boolean. Opcional. Use quando action = create || action = edit. Valor padrão: true.

Especifica se você deseja incluir um changelog. Se definido como true, uma lista de alterações (commits e problemas) entre a versão atual e a última versão publicada será gerada e acrescentada às notas de versão.

changeLogCompareToRelease - Comparar com
string. Obrigatório quando addChangeLog = true. Valores permitidos: lastFullRelease (Última versão completa), lastNonDraftRelease (Última versão não rascunho), lastNonDraftReleaseByTag (Última versão não rascunho por marca). Valor padrão: lastFullRelease.

Indica com qual versão comparar para gerar o log de alterações:

• lastFullRelease (Última versão completa): compara a versão atual com a versão não rascunho mais recente que não está marcada como pré-lançamento.
• lastNonDraftRelease (Última versão não rascunho): compara a versão atual com a versão não rascunho mais recente.
• lastNonDraftReleaseByTag (Última versão não rascunho por marca): compara a versão atual com a última versão não rascunho que corresponde à marca especificada. Você também pode especificar um regex em vez de uma marca exata.

changeLogCompareToReleaseTag - Marca de versão
string. Obrigatório quando changeLogCompareToRelease = lastNonDraftReleaseByTag && addChangeLog = true.

Especifica o regex para a marca de versão. Uma versão correspondente a essa marca será usada como base para computação de log de alterações.

changeLogType - Tipo de log de alterações
string. Obrigatório quando addChangeLog = true. Valores permitidos: commitBased (baseado em confirmação), issueBased (baseado em problema). Valor padrão: commitBased.

Especifica o tipo de log de alterações. Um log de alterações pode ser baseado em commit ou baseado em problemas. Um log de alterações baseado em commit lista todos os commits incluídos em uma versão. Um log de alterações baseado em problemas lista todos os problemas ou PRs (solicitações de pull) incluídos na versão.

changeLogLabels - Categorias
string. Opcional. Use quando changeLogType = issueBased && addChangeLog = true. Valor padrão: [{ "label" : "bug", "displayName" : "Bugs", "state" : "closed" }].

Categoriza as alterações com base no rótulo associado ao problema ou pr. Para um rótulo, você pode menção o nome de exibição para a categoria e o estado do problema. Exemplos de rótulos incluem: "[{ "label" : "bug", "displayName" : "Bugs", "state" : "closed" }]". Nos casos em que uma alteração tem vários rótulos, o primeiro rótulo especificado tem prioridade. Deixe esse campo vazio para ver uma lista simples de problemas ou PRs.

Opções de controle da tarefa

Todas as tarefas têm opções de controle além de suas entradas de tarefa. Para obter mais informações, consulte Opções de controle e propriedades comuns da tarefa.

Variáveis de saída

Nenhum.

Comentários

Há uma versão mais recente dessa tarefa disponível em GitHubRelease@1.

Requisitos

Requisito	Descrição
Tipos de pipeline	YAML, build clássico, versão clássica
Executa em	Agent, DeploymentGroup
Demandas	Nenhum
Funcionalidades	Essa tarefa não atende a nenhuma demanda para tarefas subsequentes no trabalho.
Restrições de comando	Qualquer
Variáveis configuráveis	Qualquer
Versão do agente	2.0.0 ou superior
Categoria da tarefa	Utilitário