GitHub Release (Tarea)

Azure Pipelines

Use esta tarea en la canalización para crear, editar o descartar una GitHub versión .

Requisitos previos

GitHub conexión de servicio

Esta tarea requiere una conexión GitHub servicio con permiso de escritura en el repositorio GitHub usuario. Puede crear una conexión GitHub servicio en el Azure Pipelines proyecto. Una vez creado, use el nombre de la conexión de servicio en la configuración de esta tarea.

# GitHub Release
# Create, edit, or delete a GitHub release
- task: GitHubRelease@0
  inputs:
    gitHubConnection: 
    #repositoryName: '$(Build.Repository.Name)' 
    #action: 'create' # Options: create, edit, delete
    #target: '$(Build.SourceVersion)' # Required when action == Create || Action == Edit
    #tagSource: 'auto' # Required when action == Create# Options: auto, manual
    #tagPattern: # Optional
    #tag: # Required when action == Edit || Action == Delete || TagSource == Manual
    #title: # Optional
    #releaseNotesSource: 'file' # Optional. Options: file, inline
    #releaseNotesInline: Use this option to manually enter release notes. Use with releaseNotesSource = inline
    #releaseNotesFilePath: # Optional. Use the contents of a file as release notes. 
    #releaseNotes: # Optional
    #assets: '$(Build.ArtifactStagingDirectory)/*' # Optional
    #assetUploadMode: 'delete' # Optional. Options: delete, replace
    #isDraft: false # Optional
    #isPreRelease: false # Optional
    #addChangeLog: true # Optional
    #compareWith: 'lastFullRelease' # Required when addChangeLog == True. Options: lastFullRelease, lastRelease, lastReleaseByTag
    #releaseTag: # Required when compareWith == LastReleaseByTag

Argumentos

Ejemplos

Creación de una GitHub versión

El siguiente código YAML crea una GitHub cada vez que se ejecuta la tarea. El número de compilación se usa como versión de etiqueta para la versión. Todos .exe archivos y README.txt en la carpeta $(Build.ArtifactStagingDirectory) se cargan como recursos. De forma predeterminada, la tarea también genera un registro de cambios (una lista de confirmaciones y problemas que forman parte de esta versión) y lo publica como notas de la versión.

- task: GithubRelease@1 
  displayName: 'Create GitHub Release'      
  inputs:
    gitHubConnection: zenithworks
    repositoryName: zenithworks/javaAppWithMaven
    tagSource: manual
    tag: $(Build.BuildNumber)      
    assets: |
      $(Build.ArtifactStagingDirectory)/*.exe
      $(Build.ArtifactStagingDirectory)/README.txt

También puede controlar la creación de la versión en función de las etiquetas del repositorio. El siguiente código YAML crea una GitHub solo cuando la confirmación que desencadena la canalización tiene asociada una etiqueta git. La GitHub se crea con la misma versión de etiqueta que la etiqueta de Git asociada.

- task: GithubRelease@1 
  displayName: 'Create GitHub Release'      
  inputs:
    gitHubConnection: zenithworks
    repositoryName: zenithworks/javaAppWithMaven           
    assets: $(Build.ArtifactStagingDirectory)/*.exe

También puede usar la tarea junto con las condiciones de la tarea para obtener un control aún más preciso sobre cuándo se ejecuta la tarea, lo que restringe la creación de versiones. Por ejemplo, en el siguiente CÓDIGO YAML, la tarea solo se ejecuta cuando la canalización se desencadena mediante una etiqueta git que coincide con el patrón "refs/tags/release-v*".

- task: GithubRelease@1 
  displayName: 'Create GitHub Release'   
  condition: startsWith(variables['Build.SourceBranch'], 'refs/tags/release-v')   
  inputs:
    gitHubConnection: zenithworks
    repositoryName: zenithworks/javaAppWithMaven           
    assets: $(Build.ArtifactStagingDirectory)/*.exe

Edición de GitHub versión

El siguiente código YAML actualiza el estado de una versión GitHub de "borrador" a "publicada". La versión que se va a editar viene determinada por la etiqueta especificada.

- task: GithubRelease@1
  displayName: 'Edit GitHub Release'
  inputs:
    gitHubConnection: zenithworks
    repositoryName: zenithworks/javaAppWithMaven
    action: edit
    tag: $(myDraftReleaseVersion)
    isDraft: false

Eliminación de una GitHub lanzamiento

El siguiente código YAML elimina una GitHub lanzamiento. La versión que se va a eliminar viene determinada por la etiqueta especificada.

- task: GithubRelease@1
  displayName: 'Delete GitHub Release'
  inputs:
    gitHubConnection: zenithworks
    repositoryName: zenithworks/javaAppWithMaven
    action: delete
    tag: $(myDraftReleaseVersion)

Notas de la versión insertadas

El siguiente código YAML crea una GitHub y agrega notas de la versión insertadas.

- task: GitHubRelease@1
  inputs:
    gitHubConnection: <GITHUB_SERVICE_CONNECTION>
    repositoryName: '$(Build.Repository.Name)'
    action: 'create'
    target: '$(Build.SourceVersion)'
    tagSource: 'userSpecifiedTag'
    tag: <YOUR_TAG>
    title: <YOUR_TITLE>
    releaseNotesSource: 'inline'
    releaseNotesInline: <YOUR_RELEASE_NOTES>

Código Abierto

Esta tarea es de código abierto en GitHub. Los comentarios y las contribuciones son bienvenidos.