GitVerse Release Action

GitVerse Release Action позволяет автоматически создавать или обновлять релизы и загружать артефакты. Это идеальное решение для автоматизации версионированных релизов прямо из вашего CI/CD-воркфлоу.

Быстрый старт

Добавьте в ваш репозиторий вокрфлоу:

name: release
 
on:
  push:
    tags:
      - '*'
 
jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: setup go
        uses: actions/setup-go@v4
        with:
          go-version: '>=1.23'
      - name: Create Release
        uses: actions/create-release@v1
        with:
          # Публичный API-ключ, используемый для аутентификации в GitVerse
          api_key: ${{ secrets.GITVERSE_API_KEY }}
          # Заголовок релиза
          title: Release v1.0.0
          # Описание релиза
          body: |
            ## Изменения в версии
            - Доработки: Добавлена поддержка загрузки нескольких файлов
            - Исправления: Устранен тайм-аут при загрузке
          # Список файлов релиза
          files: |
            dist/app.zip
            build/artifact.tar.gz
            README.md
          # Если `true`, создает релиз как черновик. Он не будет виден публично до ручной публикации
          draft: false
          # Помечает релиз как предварительный
          pre_release: false

Особенности

GitVerse Release Action поддерживает следующие возможности:

  1. Создание релизов по тегу.
  2. Загрузка нескольких файлов (бинарные файлы, архивы и т.д.).
  3. Замена существующих артефактов с тем же именем.
  4. Флаги черновика и предварительного релиза.

Все возможности действия могут быть настроены с помощью параметров, передаваемых в шаг Create Release.

Настройка

Для использования GitVerse Release Action вам нужно:

  1. Убедиться, что ваш workflow запускается при создании тега (см. пример выше).
  2. Создать API-ключ. Добавить секрет GITVERSE_API_KEY в настройках репозитория.
  3. Указать необходимые параметры в шаге Create Release.

Параметры

Обязательные параметры

  • api_key — публичный API-ключ, используемый для аутентификации в GitVerse. Этот ключ должен быть добавлен в секреты репозитория;
  • title — заголовок релиза;
  • body — описание релиза;
  • files — список файлов релиза, каждый файл на новой строке.

Необязательные параметры

  • draft — если true, создает релиз как черновик. Он не будет виден публично до ручной публикации;
  • pre_release — помечает релиз как предварительный.

Ограничения

  1. Максимальный размер загружаемого файла ограничен политиками GitVerse.
  2. Для загрузки артефактов требуется действительный публичный API-ключ.
⚠️

Убедитесь, что ваш API-ключ имеет права на Репозитории -> Запись для создания релизов и загрузки артефактов.

Вы нашли что искали?