Compartir a través de


GitHubRelease@0: tarea versión v0 de GitHub

Use esta tarea para crear, editar o eliminar una versión de GitHub.

Esta versión de la tarea está en desuso; use GitHubRelease@1.

Use esta tarea para crear, editar o eliminar una versión de GitHub.

Sintaxis

# 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 - conexión de GitHub (OAuth o PAT)
string. Obligatorio.

Especifica el nombre de la conexión de servicio de GitHub que se va a usar para conectarse al repositorio de GitHub. La conexión debe basarse en OAuth de un usuario de GitHub o en un token de acceso personal de GitHub. Para obtener más información sobre las conexiones de servicio, consulte Administrar conexiones de servicio.


repositorio de repositoryName -
string. Obligatorio. Valor predeterminado: $(Build.Repository.Name).

Especifica el nombre del repositorio de GitHub donde creará, editará o eliminará la versión de GitHub.


action - acción
string. Obligatorio. Valores permitidos: create, edit, delete. Valor predeterminado: create.

Especifica el tipo de operación de versión que se va a realizar. Esta tarea puede crear, editar o eliminar una versión de GitHub.


target - de destino
string. Obligatorio cuando action = create || action = edit. Valor predeterminado: $(Build.SourceVersion).

Especifica la confirmación sha que desea usar para crear la versión de GitHub, por ejemplo, 48b11d8d6e92a22e3e9563a3f643699c16fd6e27. También puede usar una variable, como $(myCommitSHA), en este campo.


de origen de tagSource - etiqueta
string. Obligatorio cuando action = create. Valores permitidos: auto (etiqueta Git), manual (etiqueta especificada por el usuario). Valor predeterminado: auto.

Especifica la etiqueta que desea usar para la creación de versiones. La opción auto (etiqueta Git) usa automáticamente la etiqueta asociada a la confirmación de Git. Use la opción manual (etiqueta especificada por el usuario) para proporcionar manualmente una etiqueta.


patrón de etiqueta de tagPattern -
string. Opcional. Use cuando tagSource = auto.

Especifica el patrón de etiqueta git mediante regex, por ejemplo, release-v1.*. La versión de GitHub solo se creará para confirmaciones que tengan la etiqueta Git coincidente.


tag - etiqueta
string. Obligatorio cuando action = edit || action = delete || tagSource = manual.

Especifica la etiqueta que desea usar al crear, editar o eliminar una versión. También puede usar una variable, como $(myTagName), en este campo.


de título de la versión de title -
string. Opcional. Use cuando action = create || action = edit.

Especifica el título de la versión de GitHub. Si se deja vacía, la etiqueta se usará como título de versión.


releaseNotesSource - origen de notas de la versión
string. Opcional. Use cuando action = create || action = edit. Valores permitidos: file (archivo de notas de la versión), input (notas de la versión en línea). Valor predeterminado: file.

Especifica la descripción de la versión de GitHub. Use la opción file (archivo de notas de la versión) para usar el contenido del archivo como notas de la versión. Use la opción input (notas de la versión en línea) para escribir manualmente las notas de la versión.


releaseNotesFile - ruta de acceso del archivo de notas de la versión
string. Opcional. Use cuando releaseNotesSource = file.

Especifica el archivo que contiene las notas de la versión.


notas de la versión de releaseNotes -
string. Opcional. Use cuando releaseNotesSource = input.

Especifica las notas de la versión. Se admite Markdown.


assets - activos
string. Opcional. Use cuando action = create || action = edit. Valor predeterminado: $(Build.ArtifactStagingDirectory)/*.

Especifica los archivos que desea cargar como recursos de la versión. Puede usar caracteres comodín para especificar varios archivos. Por ejemplo, use $(Build.ArtifactStagingDirectory)/*.zip para canalizaciones de compilación o use $(System.DefaultWorkingDirectory)/*.zip para canalizaciones de versión.

También puede especificar varios patrones, uno por línea. De forma predeterminada, se cargarán todos los archivos del directorio $(Build.ArtifactStagingDirectory). Para obtener más información sobre la lista de variables predefinidas que están disponibles, consulte variables de compilación y variables de versión de .


modo de carga de recursos de assetUploadMode -
string. Opcional. Use cuando action = edit. Valores permitidos: delete (eliminar recursos exisiting), replace (reemplazar los recursos existentes). Valor predeterminado: delete.

Especifica el modo de carga de recursos que desea usar. Use la opción delete (Eliminar recursos existentes) para eliminar primero los recursos existentes en la versión y, a continuación, cargar todos los recursos. Use la opción replace (Reemplazar recursos existentes) para reemplazar los recursos que tengan el mismo nombre.


isDraft - borrador de versión
boolean. Opcional. Use cuando action = create || action = edit. Valor predeterminado: false.

Indica si desea guardar la versión como un borrador (no publicado). Si false, se publicará la versión.


isPreRelease - versión preliminar
boolean. Opcional. Use cuando action = create || action = edit. Valor predeterminado: false.

Indica si desea marcar la versión como una versión preliminar.


addChangeLog - Agregar de registro de cambios
boolean. Opcional. Use cuando action = create || action = edit. Valor predeterminado: true.

Especifica si desea incluir un registro de cambios. Si se establece en true, se generará una lista de cambios (confirmaciones y problemas) entre la versión actual y la última versión publicada y se anexará a las notas de la versión.


changeLogCompareToRelease - Comparar con
string. Obligatorio cuando addChangeLog = true. Valores permitidos: lastFullRelease (última versión completa), lastNonDraftRelease (última versión sin borrador), lastNonDraftReleaseByTag (última versión sin borrador por etiqueta). Valor predeterminado: lastFullRelease.

Indica la versión con la que se va a comparar para generar el registro de cambios:

  • lastFullRelease (última versión completa): compara la versión actual con la versión no borrador más reciente que no está marcada como versión preliminar.
  • lastNonDraftRelease (última versión sin borrador): compara la versión actual con la versión no borrador más reciente.
  • lastNonDraftReleaseByTag (Última versión sin borrador por etiqueta): compara la versión actual con la última versión que no es de borrador que coincide con la etiqueta especificada. También puede especificar una expresión regular en lugar de una etiqueta exacta.

changeLogCompareToReleaseTag - de etiquetas de versión
string. Obligatorio cuando changeLogCompareToRelease = lastNonDraftReleaseByTag && addChangeLog = true.

Especifica la expresión regular para la etiqueta de versión. Una versión que coincida con esta etiqueta se usará como base para el cálculo del registro de cambios.


changeLogType - tipo changelog
string. Obligatorio cuando addChangeLog = true. Valores permitidos: commitBased (basado en confirmación), issueBased (basado en problemas). Valor predeterminado: commitBased.

Especifica el tipo de registro de cambios. Un registro de cambios puede basarse en confirmaciones o en problemas. Un registro de cambios basado en confirmaciones enumera todas las confirmaciones incluidas en una versión. Un registro de cambios basado en problemas enumera todos los problemas o solicitudes de incorporación de cambios (PR) incluidos en la versión.


categorías de changeLogLabels -
string. Opcional. Use cuando changeLogType = issueBased && addChangeLog = true. Valor predeterminado: [{ "label" : "bug", "displayName" : "Bugs", "state" : "closed" }].

Clasifica los cambios en función de la etiqueta asociada al problema o a la solicitud de incorporación de cambios. Para una etiqueta, puede mencionar el nombre para mostrar de la categoría y el estado del problema. Algunos ejemplos de etiquetas son: "[{ "label" : "bug", "displayName" : "Bugs", "state" : "closed" }]". En los casos en los que un cambio tiene varias etiquetas en ella, la primera etiqueta especificada tiene prioridad. Deje este campo vacío para ver una lista plana de problemas o solicitudes de incorporación de cambios.


Opciones de control de tareas

Todas las tareas tienen opciones de control además de sus entradas de tarea. Para obtener más información, consulte Opciones de control y propiedades de tareas comunes.

Variables de salida

Ninguno.

Observaciones

Hay una versión más reciente de esta tarea disponible en GitHubRelease@1.

Requisitos

Requisito Descripción
Tipos de canalización YAML, compilación clásica, versión clásica
Se ejecuta en Agente, DeploymentGroup
demandas Ninguno
funcionalidades de Esta tarea no satisface ninguna demanda de tareas posteriores en el trabajo.
restricciones de comandos Cualquiera
variables settable Cualquiera
Versión del agente 2.0.0 o superior
Categoría de tarea Utilidad