Поделиться через

GitHubRelease@0 — задача выпуска GitHub версии 0

  • Статья

Используйте эту задачу для создания, редактирования или удаления выпуска GitHub.

Эта версия задачи устарела; используйте GitHubRelease@1.

Используйте эту задачу для создания, редактирования или удаления выпуска GitHub.

Синтаксис

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

Входные данные

gitHubConnection - подключение GitHub (OAuth или PAT)
string. Обязательное.

Указывает имя подключения службы GitHub для подключения к репозиторию GitHub. Подключение должно быть основано на OAuth пользователя GitHub или личном маркере доступа GitHub. Дополнительные сведения о подключениях служб см. в разделе Управление подключениями служб.


repositoryName - репозитория
string. Обязательное. Значение по умолчанию: $(Build.Repository.Name).

Указывает имя репозитория GitHub, в котором вы создадите, измените или удалите выпуск GitHub.


action - действие
string. Обязательное. Допустимые значения: create, edit, delete. Значение по умолчанию: create.

Указывает тип выполняемой операции выпуска. Эта задача может создавать, изменять или удалять выпуск GitHub.


target - Целевой
string. Требуется, если action = create || action = edit. Значение по умолчанию: $(Build.SourceVersion).

Указывает фиксацию SHA, которую вы хотите использовать для создания выпуска GitHub, например 48b11d8d6e92a22e3e9563a3f643699c16fd6e27. В этом поле можно также использовать переменную, например $(myCommitSHA).


источника тегов tagSource -
string. Требуется, если action = create. Допустимые значения: auto (тег Git), manual (указанный пользователем тег). Значение по умолчанию: auto.

Указывает тег, который требуется использовать для создания выпуска. Параметр auto (тег Git) автоматически использует тег, связанный с фиксацией Git. Используйте параметр manual (указанный пользователем тег), чтобы вручную предоставить тег.


шаблона тегов tagPattern -
string. Необязательно. Используется при tagSource = auto.

Задает шаблон тега Git с помощью regex, например release-v1.*. Выпуск GitHub будет создан только для фиксаций с соответствующим тегом Git.


тегов
string. Требуется, если action = edit || action = delete || tagSource = manual.

Указывает тег, который вы хотите использовать при создании, редактировании или удалении выпуска. В этом поле можно также использовать переменную, например $(myTagName).


title - название выпуска
string. Необязательно. Используется при action = create || action = edit.

Задает заголовок выпуска GitHub. Если оставить пустым, тег будет использоваться в качестве заголовка выпуска.


Исходные releaseNotesSource - заметки о выпуске
string. Необязательно. Используется при action = create || action = edit. Допустимые значения: file (файл заметок о выпуске), input (встроенные заметки о выпуске). Значение по умолчанию: file.

Указывает описание выпуска GitHub. Используйте параметр file (файл заметок о выпуске) для использования содержимого файла в качестве заметок о выпуске. Используйте параметр input (встроенные заметки о выпуске), чтобы вручную ввести заметки о выпуске.


releaseNotesFile - пути к файлу заметок о выпуске
string. Необязательно. Используется при releaseNotesSource = file.

Указывает файл, содержащий заметки о выпуске.


заметки о выпуске releaseNotes -
string. Необязательно. Используется при releaseNotesSource = input.

Указывает заметки о выпуске. Markdown поддерживается.


assets - активы
string. Необязательно. Используется при action = create || action = edit. Значение по умолчанию: $(Build.ArtifactStagingDirectory)/*.

Указывает файлы, которые нужно отправить в качестве ресурсов выпуска. Для указания нескольких файлов можно использовать подстановочные знаки. Например, используйте $(Build.ArtifactStagingDirectory)/*.zip для конвейеров сборки или используйте $(System.DefaultWorkingDirectory)/*.zip для конвейеров выпуска.

Можно также указать несколько шаблонов, по одному на строку. По умолчанию все файлы в каталоге $(Build.ArtifactStagingDirectory) будут отправлены. Дополнительные сведения о списке доступных предварительно определенных переменных см. в переменных сборки и переменных выпуска.


режима отправки ресурсов assetUploadMode -
string. Необязательно. Используется при action = edit. Допустимые значения: delete (удаление экссизивных ресурсов), replace (замена существующих ресурсов). Значение по умолчанию: delete.

Указывает режим отправки ресурса, который требуется использовать. Используйте параметр delete (Удалить существующие ресурсы), чтобы сначала удалить все существующие ресурсы в выпуске, а затем передать все ресурсы. Используйте параметр replace (заменить существующие ресурсы) для замены всех ресурсов с одинаковым именем.


isDraft - выпуск черновика
boolean. Необязательно. Используется при action = create || action = edit. Значение по умолчанию: false.

Указывает, нужно ли сохранить выпуск в виде черновика (не опубликовано). Если false, выпуск будет опубликован.


isPreRelease - предварительной версии
boolean. Необязательно. Используется при action = create || action = edit. Значение по умолчанию: false.

Указывает, нужно ли пометить выпуск как предварительную версию.


addChangeLog - Добавление журнала изменений
boolean. Необязательно. Используется при action = create || action = edit. Значение по умолчанию: true.

Указывает, требуется ли включить журнал изменений. Если задано значение true, будет создан список изменений (фиксаций и проблем) между текущим выпуском и последним опубликованным выпуском, который будет добавлен в заметки о выпуске.


сравнение changeLogCompareToRelease - с
string. Требуется, если addChangeLog = true. Допустимые значения: lastFullRelease (последний полный выпуск), lastNonDraftRelease (последний выпуск, отличный от черновика), lastNonDraftReleaseByTag (последний выпуск без черновика по тегу). Значение по умолчанию: lastFullRelease.

Указывает, какой выпуск следует сравнить с тем, чтобы создать журнал изменений:

  • lastFullRelease (последний полный выпуск): сравнивает текущий выпуск с последним выпуском, не помеченным как предварительный выпуск.
  • lastNonDraftRelease (последний выпуск, отличный от черновика): сравнивает текущий выпуск с последним неоконвиком.
  • lastNonDraftReleaseByTag (Последний выпуск, отличный от черновика по тегу): сравнивает текущий выпуск с последним выпуском, не соответствующим указанному тегу. Вы также можете указать regex вместо точного тега.

changeLogCompareToReleaseTag - тег выпуска
string. Требуется, если changeLogCompareToRelease = lastNonDraftReleaseByTag && addChangeLog = true.

Задает regex для тега выпуска. Выпуск, соответствующий этому тегу, будет использоваться в качестве базы для вычисления журнала изменений.


changeLogType - тип журнала изменений
string. Требуется, если addChangeLog = true. Допустимые значения: commitBased (на основе фиксации), issueBased (на основе проблем). Значение по умолчанию: commitBased.

Указывает тип журнала изменений. Журнал изменений может быть основан на фиксации или на основе проблем. В журнале изменений на основе фиксации перечислены все фиксации, включенные в выпуск. В журнале изменений на основе проблем перечислены все проблемы или запросы на вытягивание (PR), включенные в выпуск.


категории changeLogLabels -
string. Необязательно. Используется при changeLogType = issueBased && addChangeLog = true. Значение по умолчанию: [{ "label" : "bug", "displayName" : "Bugs", "state" : "closed" }].

Классифицирует изменения на основе метки, связанной с проблемой или pr. Для метки можно указать отображаемое имя категории и состояние проблемы. Примеры меток: "[{ "label" : "bug", "displayName" : "Bugs", "state" : "closed" }]". В случаях, когда изменение содержит несколько меток, первая указанная метка имеет приоритет. Оставьте это поле пустым, чтобы просмотреть неструктурированный список проблем или PR.


Параметры управления задачами

Помимо входных данных, все задачи имеют параметры управления. Дополнительные сведения см. в разделе Параметры управления и общие свойства задач.

Выходные переменные

Нет.

Замечания

В GitHubRelease@1доступна более новая версия этой задачи.

Требования

Требование Описание
Типы конвейеров YAML, классическая сборка, классический выпуск
Выполняется в Агент, DeploymentGroup
требования Нет
возможностей Эта задача не удовлетворяет требованиям к последующим задачам в задании.
ограничения команд Любое
переменные settable Любое
Версия агента 2.0.0 или более поздней версии
Категория задач Полезность