Что такое кнопка сборки и прохождения в github?

Question

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

Редактировать 1
Есть ли какая-либо проблема (оплата) с теми или теми, которые бесплатны?

Answer 1

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

• build: passing: означает, что все тесты проекта пройдены. Обычно это настраивается через Travis-CI интеграция.
• coverage: сколько проекта протестировано. 75% кода на вашем изображении прошел модульные тесты.
• dependenices: Сколько зависимостей у репозитория от других репозиториев, чтобы запустить
• devDependencies: Сколько зависимостей у репозитория от других репозиториев для разработки

Answer 2

Это нечто, известное как Значки репозитория кода .

Цитировать онлайн ресурс :

Как люди, которые увлечены написанием отличного кода, мы показываем «значки» в наших репозиториях кода, чтобы дать понять коллегам-разработчикам, что мы сами устанавливаем высокие стандарты для кода, который мы пишем, воспринимать их как программный эквивалент бренда на ваши джинсы или другой надежный продукт.

Короче говоря, это способ сказать, что «эй, смотри, мой проект GitHub имеет высокий стандарт!». Ссылка выше на самом деле довольно подробно рассказывает о различных значках, но позвольте мне указать на два общих, показанных на вашей картинке:

1. "Сборка прохождения"

Для этого используются инструменты непрерывной интеграции, такие как Travis CI , которые помогут создавать и тестировать ваш код, когда вы помещаете код в репозиторий GitHub (учитывая, что вы настроили Travis CI для этого репозитория).

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

2. "Покрытие"

Показывает, сколько кода в вашем проекте GitHub действительно протестировано. Он использует такие инструменты, как Codecov , опять же исходя из того факта, что вы настроили такие инструменты для своего хранилища.

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

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

Answer 3

Какие они

Это "значки". Значки предлагаются всеми видами инструментов сборки, менеджерами пакетов и т. Д.

Допустим, вы используете AppVeyor для непрерывной интеграции и развертываний. В настройках вашего проекта в AppVeyor они предоставляют фрагмент HTML / markdown, который можно встроить в такие места, как GitHub, чтобы показать всем, кто смотрит на ваш файл GitHub readme, что последняя сборка Был успешен.

Значки обычно (но не всегда) являются динамическими в том смысле, что поставщик услуг (npm, AppVeyor и т. Д.) Будет обслуживать значок по URL-адресу (в фрагменте кода, который вы получаете), и когда клиент получает это изображение, он будет показать последнее состояние данных значка (сборка прошла успешно / не удалось, доступно на npm, тесты не пройдены, охват кода% и т. д.).

Как их использовать

Вы получаете фрагмент кода от поставщика услуг (npm, AppVeyor и т. Д.) И просто вставляете его прямо в свой файл readme или куда хотите.

Какая выгода

Это, очевидно, меняется в зависимости от того, что показывает значок, но некоторые примеры могут быть:

• Значок статуса сборки: Сообщает, может ли быть собран последний код в текущей ветви. Полезно для быстрого показа людям, что есть WIP или проблемы с кодовой базой.
• Значок покрытия кода: Сообщает вам% кода, покрытого модульными тестами. Полезно, если вы столкнулись с репозиторием GitHub и хотели знать качество кодовой базы и покрытия модульного тестирования, если это важно для вас.
• Значок прохождения тестов: Сколько тестов пройдено / не пройдено. Как и в случае сбоя сборки, вы можете быстро увидеть красный свет как потенциальный пользователь этой библиотеки или даже как разработчик в команде, Houston, we have a problem.
• Значки NPM: Значки версий, доступные, количество загрузок и т. Д. Являются полезными индикаторами информации для людей.
• Разное. статические значки: Некоторые службы / библиотеки предлагают значки, которые являются просто статичными и обычно используются в рекламных целях для их библиотеки / бренда / службы. Framework X может создать значок со своим логотипом / именем, и разработчики, которым нравится, могут сказать, что их веб-сайт / платформа зависит от / использует Framework X, поместив этот значок в свой файл readme.
• Возможности бесконечны.