С интеграцией GitHub вы видите pull requests, запуски GitHub Actions, окружения и коммиты прямо в задачах FeatValue. Клиенты простыми словами узнают, находится ли их изменение в работе, на staging для проверки или уже опубликовано.
Для чего нужна интеграция с GitHub
Разработчики ПО и веб-агентства постоянно слышат один и тот же вопрос: «Это уже онлайн?» С интеграцией FeatValue отвечает на него прямо в задаче:
- Ветки, коммиты и pull requests с идентификатором задачи появляются в соответствующей задаче.
- Запуски GitHub Actions и развёртывания показывают, протестировано ли изменение и в какое окружение оно попало.
- FeatValue записывает важные шаги комментариями в историю задачи.
- Для каждого проекта вы решаете, что из этого видят клиенты.
- Упавшие запуски вы перезапускаете прямо из FeatValue.
Обзор вы найдёте на странице об интеграции с GitHub.
Требования
- аккаунт FeatValue вашей компании хотя бы с одним клиентом и проектом (см. Создание проектов)
- аккаунт или организация на github.com
- право устанавливать приложения в этот аккаунт или организацию. В организациях это владельцы (owners). Другие участники могут запросить установку, и владелец затем подтверждает её в GitHub.
Подключить GitHub
-
Откройте приложение
-
Подключите GitHub
Нажмите
Подключить GitHub. Короткая подсказка перечислит разрешения, которые запрашивает приложение (см.
Разрешения GitHub App). Нажмите
Перейти в GitHub.
-
Войдите в GitHub
Войдите в GitHub и авторизуйте приложение FeatValue.
-
Установите приложение или выберите организации
Если приложение ещё нигде не установлено, GitHub сразу откроет установку: выберите свой аккаунт или организацию, затем All repositories или в пункте Only select repositories репозитории, которые FeatValue может видеть, и нажмите Install. Если приложение уже установлено в нескольких организациях, выберите на странице выбора организации, которые хотите подключить. После этого вы вернётесь в FeatValue.
Давайте доступ только к тем репозиториям, которые хотите связать с проектами FeatValue. Изменить выбор можно в любой момент в GitHub у приложения FeatValue: в личном аккаунте в разделе Settings › Applications › Installed GitHub Apps, в организации в разделе Organization settings › Third-party Access › GitHub Apps.
Разрешения GitHub App
Приложение FeatValue запрашивает у GitHub такие разрешения:
- Metadata: read: названия и основные данные репозиториев, к которым дан доступ
- Contents: read: коммиты и сравнения веток
- Pull requests: read: pull requests с названием, статусом и веткой
- Actions: read & write: чтение запусков GitHub Actions, запись только для перезапуска
- Deployments: read: развёртывания и окружения
GitHub App запрашивает доступ на чтение содержимого репозитория (Contents: read), потому что GitHub отдаёт коммиты и сравнения веток только с этим разрешением. FeatValue читает с его помощью только данные коммитов (сообщение, автор, время) и сравнения веток, но не исходный код, и не хранит никаких файлов.
Связать репозиторий с проектом
Каждый репозиторий относится ровно к одному проекту FeatValue. В FeatValue попадают только связанные репозитории.
-
Откройте «Связать репозитории»
Откройте
Настройки › Компания › Интеграции и приложения и выберите
GitHub (см.
Подключённые приложения). Страница называется
Связать репозитории.
-
Найдите репозиторий
Репозитории, к которым вы дали приложению доступ, перечислены в разделе Репозитории в GitHub. С помощью Найти репозиторий вы сужаете список.
-
Выберите проект и свяжите
Рядом с репозиторием выберите Проект FeatValue и нажмите Связать. FeatValue подгружает данные за последние несколько дней. Создавать вебхук не нужно, события приходят через приложение FeatValue.
Все связи перечислены в разделе Связанные репозитории. В столбце Обновление указано Сразу через вебхук. Кнопка Изменить позволяет выбрать другой проект, а Отвязать удаляет связь.
Несколько организаций в одном подключении
Одно подключение FeatValue может использовать приложение из всех организаций и аккаунтов GitHub, где оно установлено и к которым у вас есть доступ при подключении, например из вашей организации и организаций ваших клиентов. Список на странице Связать репозитории сгруппирован по организациям.
-
Добавьте организацию
Откройте Настройки › GitHub (страница Связать репозитории) и нажмите Добавить организацию.
-
Выберите организацию
Выберите организацию, где приложение уже установлено. Если её нет, нажмите Установить в другой организации и установите приложение там в GitHub.
-
Свяжите репозитории
Репозитории организации появятся в списке. Свяжите их, как описано выше.
Одну и ту же установку могут использовать несколько компаний в FeatValue, например ваше агентство и ваш клиент со своим аккаунтом FeatValue.
Как правильно использовать идентификатор задачи
У каждой задачи в FeatValue есть идентификатор, например abc123-4. Вы найдёте его в задаче. Укажите этот идентификатор в одном из этих мест:
| Где |
Пример |
| Название ветки |
abc123-4-contact-form |
| Сообщение коммита |
abc123-4 Сделать телефон обязательным |
| Заголовок или описание pull request |
Контактная форма: телефон обязателен (abc123-4) |
- Регистр букв не важен, допускается
# в начале.
- Если идентификатор стоит в названии ветки, учитываются только коммиты, которые есть исключительно в этой ветке. Коммиты из основной ветки, попавшие в неё при ответвлении, в задаче не появляются.
- Коммиты в других ветках появляются, только если идентификатор есть в их сообщении коммита.
- Идентификатор действует только внутри связанного проекта. Репозитории, связанные с другим проектом или не связанные вовсе, FeatValue никогда не привязывает.
- Запуски GitHub Actions и развёртывания относятся к задаче, если они запущены для одной из её веток, её коммитов или pull requests.
Что появляется в задаче
В задаче есть раздел Разработка с одной компактной строкой, например: PR #12 слит · Workflow успешен · Развёрнуто на Staging. Нажмите Показать подробности, чтобы развернуть:
- Workflows: запуски GitHub Actions, например CI #57, с их заданиями и статусом
- Окружения из ваших развёртываний со ссылкой для открытия, например Staging и Production
- Pull requests, Ветки и Коммиты
Что появляется в проекте
В проекте раздел Разработка показывает окружения с последним развёртыванием и последний запуск основной ветки. Нажмите Показать все запуски workflow, чтобы увидеть Последние запуски workflow. Здесь же находятся Настройки проекта.
Что видят клиенты?
В Настройках раздела Разработка в проекте выберите в пункте Что видят клиенты?:
| Настройка |
Ваш клиент видит |
| Ничего |
никакой информации из GitHub |
| Простой статус |
одно предложение без технических терминов: В работе, Развёрнуто на Staging со ссылкой протестировать здесь или Опубликовано со ссылкой посмотреть |
| Подробности |
разделы, отмеченные в пункте Подробности для клиентов: коммиты, ветки, pull requests, workflows, окружения и комментарии истории |
Эту настройку могут менять сотрудники вашей компании, которым разрешено редактировать проект. Как клиент затем тестирует и принимает задачу, описано в разделе Ревью и приёмка.
Настройка комментариев в истории
FeatValue записывает важные шаги комментариями в историю задачи. В пункте Комментарии истории в задаче вы выбираете для каждого проекта, какие события создают комментарий:
- Pull request слит
- Workflow успешен
- Workflow с ошибкой (с неудачными заданиями)
- Развёрнуто в окружении
Отключённые события по-прежнему обновляют статус в задаче, но больше не создают комментарий. Видит ли клиент комментарии, зависит от настройки в пункте Что видят клиенты?.
Перезапуск упавших запусков
Starter
Если запуск GitHub Actions завершился ошибкой или был отменён, вы перезапускаете его прямо в FeatValue. Для запуска с ошибкой GitHub повторяет только упавшие задания, для отменённого запуска весь запуск целиком. Это доступно начиная с тарифа Starter (см. Тарифы).
-
Разрешите workflows
В проекте откройте Настройки раздела Разработка. В пункте Перезапуск workflows из FeatValue перечислены workflows, для которых GitHub уже сообщал о запуске с ошибкой, например CI. Отметьте workflows, которые должны появляться в FeatValue, и нажмите Сохранить.
-
Также для клиентов
Если клиент тоже должен иметь возможность перезапускать выбранные workflows, отметьте Клиенты тоже могут перезапускать выбранные workflows.
-
Перезапустите
Упавший запуск разрешённого workflow появляется с кнопкой Перезапустить. После нажатия FeatValue показывает Перезапущено, а дальнейший ход вы отслеживаете в запуске.
Безопасность
- Только разрешённые и связанные репозитории: приложение FeatValue видит только репозитории, к которым вы дали доступ при установке. FeatValue привязывает идентификаторы задач только в репозиториях, которые вы связали с проектом, и только внутри этого проекта.
- Без исходного кода: FeatValue читает только данные коммитов и сравнения веток, но не исходный код, и не хранит файлы из вашего репозитория. Для этого приложение запрашивает Contents: read (см. Разрешения GitHub App).
- Проверенные вебхуки: GitHub подписывает каждую доставку в FeatValue. FeatValue принимает только вызовы с действительной подписью.
- Минимум прав на запись: единственное, что приложение может изменить, это перезапуск запусков GitHub Actions, и только для разрешённых вами workflows.
- Отвязать в любой момент: Отвязать удаляет связь. Если вы удалите приложение в GitHub, FeatValue автоматически отвяжет репозитории этой организации.
Отключение и удаление приложения
Если вы отключите GitHub в FeatValue, FeatValue удалит только связи репозиториев. То, что уже показано в задачах, сохранится. Приложение останется установленным в GitHub, пока вы не удалите его там:
- Организация: Откройте в GitHub Organization settings › Third-party Access › GitHub Apps, нажмите Configure у приложения FeatValue и в самом низу Uninstall.
- Личный аккаунт: Откройте Settings › Applications › Installed GitHub Apps, нажмите Configure у приложения FeatValue, а затем Uninstall.
После удаления приложения FeatValue автоматически отвяжет репозитории этой организации.
Устранение неполадок
Моего репозитория нет в списке
FeatValue показывает только репозитории, к которым вы дали приложению доступ. В GitHub откройте Settings › Applications › Installed GitHub Apps, выберите приложение FeatValue и добавьте репозиторий в пункте Repository access. Для организации это находится в настройках организации.
Установка ждёт подтверждения
Если вы не владелец организации, GitHub отправляет запрос на установку владельцам. Как только владелец его подтвердит, снова подключите GitHub в FeatValue.
В задаче ничего не появляется
- Связан ли репозиторий с проектом, к которому относится задача?
- Указан ли полный идентификатор задачи в названии ветки, сообщении коммита или pull request?
- Если доставка из GitHub потерялась, FeatValue подгружает данные в течение 10 минут.
Запуск не перезапускается
Перезапуск доступен начиная с тарифа Starter. Кроме того, workflow должен быть разрешён в настройках проекта, а запуск должен завершиться ошибкой или быть отменён. Если появляется Не удалось перезапустить, проверьте в GitHub, установлено ли ещё приложение и видит ли оно репозиторий.
В списке выбора нет организации
FeatValue показывает только организации, где установлено приложение и к которым есть доступ у вашего аккаунта GitHub. Установите приложение через Установить в другой организации или попросите об этом владельца организации.