автоматические выпуски действий

Автоматические выпуски GitHub

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

Содержание

1. Примеры использования
2. Поддерживаемые параметры
3. Триггеры событий
4. Управление версиями
5. Как получить помощь
6. Лицензия

ПРИМЕЧАНИЕ . Репозиторий marvinpinto/action-automatic-releases представляет собой автоматически создаваемое зеркало монорепозитория marvinpinto/actions, содержащего это и другие действия. Пожалуйста, сообщайте о проблемах и отправляйте запросы туда.

Примеры использования

Автоматически создавать предварительную версию, когда изменения попадают в мастер-версию

Этот пример рабочего процесса вступит в силу, как только изменения попадут в master . После выполнения шагов по сборке и тестированию вашего проекта:

1. Он создаст (или заменит) тег git с именем latest .
2. Создайте журнал изменений из всех коммитов между этим и предыдущим latest тегом.
3. Создайте новый выпуск, связанный с latest тегом (удалив все предыдущие связанные выпуски).
4. Обновите этот новый выпуск с указанным названием (например, Development Build ).
5. Загрузите LICENSE.txt и любые файлы jar в качестве ресурсов выпуска.
6. Отметить этот выпуск как pre-release .

Вы можете увидеть рабочий пример этого рабочего процесса по адресу marvinpinto/actions.

---
name : " pre-release "

on :
  push :
    branches :
      - " master "

jobs :
  pre-release :
    name : " Pre Release "
    runs-on : " ubuntu-latest "

    steps :
      # ...
      - name : " Build & test "
        run : |
          echo "done!"

      - uses : " marvinpinto/action-automatic-releases@latest "
        with :
          repo_token : " ${{ secrets.GITHUB_TOKEN }} "
          automatic_release_tag : " latest "
          prerelease : true
          title : " Development Build "
          files : |
            LICENSE.txt
            *.jar

Создайте новый выпуск GitHub, когда теги будут отправлены в репозиторий.

Как и в предыдущем примере, этот рабочий процесс начнется, как только новые теги будут отправлены на GitHub. После сборки и тестирования вашего проекта:

1. Создайте журнал изменений из всех коммитов между этим и предыдущим тегом, похожим на semver.
2. Создайте новый выпуск и свяжите его с этим тегом.
3. Загрузите LICENSE.txt и любые файлы jar в качестве ресурсов выпуска.

Еще раз пример этого можно найти в marvinpinto/actions.

---
name : " tagged-release "

on :
  push :
    tags :
      - " v* "

jobs :
  tagged-release :
    name : " Tagged Release "
    runs-on : " ubuntu-latest "

    steps :
      # ...
      - name : " Build & test "
        run : |
          echo "done!"

      - uses : " marvinpinto/action-automatic-releases@latest "
        with :
          repo_token : " ${{ secrets.GITHUB_TOKEN }} "
          prerelease : false
          files : |
            LICENSE.txt
            *.jar 

Поддерживаемые параметры

Параметр	Описание	По умолчанию
repo_token **	Токен действия GitHub, например "${{ secrets.GITHUB_TOKEN }}" .	null
draft	Отметить этот выпуск как черновик?	false
prerelease	Отметить этот выпуск как предварительный?	true
automatic_release_tag	Имя тега, которое будет использоваться для автоматических выпусков, например, latest .	null
title	Название выпуска; по умолчанию используется имя тега, если оно не указано.	Имя тега
files	Файлы для загрузки как часть ресурсов выпуска.	null

Выходы

Доступ к следующим выходным значениям можно получить через ${{ steps..outputs. }} :

Имя	Описание	Тип
automatic_releases_tag	Тег выпуска, который только что обработан этим действием.	нить
upload_url	URL-адрес для загрузки дополнительных ресурсов в релиз	нить

Примечания:

• Параметры, отмеченные ** являются обязательными.
• Параметр files поддерживает многострочные шаблоны, см. примеры репозитория.

Триггеры событий

Платформа действий GitHub позволяет запускать это (и другие) действия при многих комбинациях событий. Например, вы можете создавать специальные предварительные выпуски для тегов-кандидатов на выпуск (например, *-rc* ), генерировать выпуски по мере поступления изменений в основной выпуск (пример выше), ночные выпуски и многое другое. Прочтите синтаксис рабочего процесса для действий GitHub, чтобы найти идеи и сложные примеры.

Управление версиями

Каждый коммит, попадающий на master для этого проекта, запускает автоматическую сборку, а также выпуск с тегом latest . Если вы не хотите жить на переднем крае, вы можете вместо этого использовать стабильную версию. См. выпуски доступных версий.

"">

- uses : " marvinpinto/action-automatic-releases@ " 

Как получить помощь

Основной README этого проекта содержит множество информации, связанной с проблемами отладки и отправки. Если вы все еще застряли, попробуйте связаться со мной по базе ключей, и я сделаю все возможное, чтобы помочь вам.

Лицензия

Исходный код этого проекта выпущен под лицензией MIT. Этот проект не связан с GitHub.