Работа с релизами в SourceCraft

Релиз — это зафиксированная версия программного продукта, включающая определенный набор изменений, тег, описание и дополнительные ресурсы, например бинарные файлы или архивы, предназначенные для пользователей или других разработчиков.

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

Релизы в SourceCraft привязываются к тегу репозитория — маркировке важной точки в истории проекта. К одному тегу может быть привязан только один релиз.

Подробнее на странице Релизы в SourceCraft.

Создать релиз

Откройте главную страницу SourceCraft.
На вкладке Домой в секции Ваша мастерская перейдите в раздел Репозитории и выберите репозиторий.
В разделе Код перейдите в секцию Релизы.
В правом верхнем углу нажмите Новый релиз.
В блоке Общая информация:
1. Выберите тег, на основе которого будет создан релиз.
  
  Примечание
  
  Можно выбрать только тот тег, на основе которого еще не был создан ни один релиз.
  
  Вы можете использовать заранее созданный тег или создать новый.
  
  Чтобы создать новый тег:
  1. В поле выбора тега нажмите .
  2. В поле Тег введите название тега.
  3. В поле Цель выберите ветку, на основе которой будет создан тег.
  4. Нажмите Сохранить.
2. Введите название релиза.
(опционально) В блоке Примечания к релизу:
- выберите предыдущий релиз;
- введите описание релиза, например укажите, что изменилось, было исправлено или улучшено, а также уточните особенности обновления.
(опционально) В блоке Ресурсы релиза нажмите Добавить ресурс и выберите тип ресурса:
- Файл — нажмите Обзор и загрузите файл с локального компьютера.
  
  Ограничения
  
  В SourceCraft установлены лимиты на объем загружаемых в релиз файлов.
- Ссылка — введите ссылку на внешний ресурс и отображаемое название.
Чтобы добавить еще ресурс, нажмите Добавить ресурс.

Чтобы удалить ресурс, напротив него нажмите .
Нажмите Опубликовать релиз.

Совет

Также вы можете не публиковать релиз, а сохранить его черновик, чтобы доработать позже. Для этого нажмите Сохранить черновик.

Описание и содержимое черновика релиза доступны пользователям с ролью Администратор репозитория и ролью Ответственный за репозиторий.

Посмотреть релиз

Откройте главную страницу SourceCraft.
На вкладке Домой в секции Ваша мастерская перейдите в раздел Репозитории и выберите репозиторий.
В разделе Код перейдите в секцию Релизы.

На странице будет выведен список релизов с указанием авторов, дат и времени публикации, тегов, коммитов, описаний и приложенных ресурсов.

Также в списке будет отмечен последний релиз.
Выберите релиз, который вы хотите просмотреть.

Скачать ресурсы релиза

Каждый опубликованный релиз содержит в блоке Ресурсы релиза:

автоматически сгенерированные архивы с исходным кодом релиза в форматах .zip и .tar.gz;
файлы, приложенные к релизу при его создании или редактировании;
ссылки на внешние ресурсы.

Скачать их можно через интерфейс SourceCraft или с помощью REST API.

Интерфейс SourceCraft

REST API

Откройте главную страницу SourceCraft.
На вкладке Домой в секции Ваша мастерская перейдите в раздел Репозитории и выберите репозиторий.
В разделе Код перейдите в секцию Релизы.
В карточке нужного релиза в блоке Ресурсы релиза выберите ресурс:
- Исходный код (zip) — скачать архив с исходным кодом релиза в формате .zip.
- Исходный код (tar.gz) — скачать архив с исходным кодом релиза в формате .tar.gz.
- <название_файла> — скачать файл, прикрепленный к релизу.
- <ссылка> — открыть внешний ресурс.

Получить ссылки на ресурсы релиза можно с помощью метода Get Release (By Tag) REST API SourceCraft. В ответе на запрос в поле assets будет приведен список ресурсов релиза. В каждом ресурсе ссылка для скачивания доступна в одном из полей:

archive_link.link — ссылка на архив с исходным кодом релиза;
link — ссылка на приложенный файл или на внешний ресурс.

Чтобы получить ссылки на ресурсы релиза:

Получите персональный токен (PAT) для аутентификации в API.
Выполните запрос:
```
export PAT=<персональный_токен>
curl \
    --request GET \
    --header "Authorization: Bearer $PAT" \
    --url "https://api.sourcecraft.tech/repos/<слаг_организации>/<слаг_репозитория>/releases/tag/<тег_релиза>" | jq
```
Где:
- <слаг_организации> — слаг организации, которой принадлежит репозиторий;
- <слаг_репозитория> — слаг репозитория, в котором опубликован релиз;
- <тег_релиза> — тег, на основе которого создан релиз.
Скачайте архив с исходным кодом релиза с помощью утилиты wget, используя ссылку из поля archive_link.link:
```
wget "<ссылка_из_поля_archive_link.link>" --output-document=<имя_файла>.tar.gz
```
Чтобы скачать приложенный к релизу файл или открыть внешнюю ссылку, используйте значение поля link.

Подробнее об аутентификации и работе с SourceCraft REST API смотрите на странице Работа с REST API SourceCraft.

Редактировать релиз

Важно

Отредактировать можно только черновик релиза.

Откройте главную страницу SourceCraft.
На вкладке Домой в секции Ваша мастерская перейдите в раздел Репозитории и выберите репозиторий.
В разделе Код перейдите в секцию Релизы.
Напротив черновика релиза, который вы хотите изменить, нажмите и выберите Редактировать.
Измените параметры релиза и нажмите Обновить релиз.

Отменить и удалить релиз

Примечание

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

Откройте главную страницу SourceCraft.
На вкладке Домой в секции Ваша мастерская перейдите в раздел Репозитории и выберите репозиторий.
В разделе Код перейдите в секцию Релизы.
Напротив релиза, который вы хотите отменить, нажмите и выберите Отменить релиз.

При этом описание и содержимое отмененного релиза остаются доступны пользователям с ролью Администратор репозитория и ролью Ответственный за репозиторий.
Чтобы удалить релиз из репозитория, напротив релиза нажмите , выберите Удалить и подтвердите удаление.

Сравнить релизы

Откройте главную страницу SourceCraft.
На вкладке Домой в секции Ваша мастерская перейдите в раздел Репозитории и выберите репозиторий.
В разделе Код перейдите в секцию Релизы.
Напротив релиза, который вы хотите сравнить с другим, нажмите Сравнить и выберите релиз для сравнения.

Полезные ссылки

Была ли статья полезна?

Метки (labels)

Создать тег