Удивительно, многие Открытый источник Проекты не реализуют Непрерывная интеграция (CI) решение. Возможно, ваш проект является одним из них. Возможно, вы думаете: «Нам это не нужно, мы знаем, что мы делаем» или даже, «Мы слишком маленькие, мы будем реализовывать это позже».
Когда сопровождающие используют CI, часто недостаточная реализация, такая как использование его для развертывания без каких-либо тестирования.
Я должен знать; Я был виновен в этом сам.
Но я хочу показать вам, что решение для реализации CI для Открытый источник Проект не о вас. Это о предоставлении правильных инструментов для вкладов. Речь идет о том, чтобы ваш проект неуклонно расти с здоровым кодом.
Использование CI в вашем Открытый источник Проекты помогут расширить возможности своих участников, чтобы получить лучшие PRS легче и помочь вашему проекту расти и процветать.
Читайте на четыре пути, которые CI может расширить возможности вашего Открытый источник Укладки:
1. CI будет фактически запустить тесты
Это может показаться очевидным, но вполне важно упомянуть. Содержание, которые вложили время в размышления о тестировании для их проекта, должны передать это для потенциальных участников.
Как? Вы можете напомнить людям, чтобы запустить тесты:
- В
Readme.md.md
- В
Вклад
- Или в Повторите запрос (PR) шаблон
Но даже с этими шагами предприняты, сколько людей на самом деле будут читать их и пройти? Запуск тестов проекта с поставщиком CI, как Circleci означает, что вам не нужно беспокоиться о стране, будучи ленивым или забывчивым. Это защитная сеть для качества кода вашего проекта.
2. Сбой сборки CI в порядке; использовать их как преподавательскую позицию
Это может быть запугивающему внести свой вклад в Открытый источник Проект впервые. Позвольте участникам знают, что PRS приветствуется, но что более важно, что им не нужно получить правильно на первой попытке. Если чек-чек PR станет красным, отлично! Первое, что вы можете сделать, это убедиться, что пользователи знают, как нажать к провайдеру CI и проверьте ошибку (тестовое прохождение/неспособность ссылки в нижнем колонтитуре PR). Не думайте ничего. Тогда вы можете дать этот человек совет о том, как решить проблему и дать им время сделать это. Идея вот что это преподавательская точка. Помните: они могут не выбить ошибки в том же темпе, сколько сможете. Вкладчик может учиться и становиться сильнее, в то время как это взаимодействие устанавливает тон для вашего проекта и его сообщества. Будьте дружелюбны и исправить вещи вместе.
3. CI позволяет участникам работать над проектами, которые они могут не смогли не в состоянии
Я объясню это с реальным примером. Давайте посмотрим на Circleci CLI , Открытый источник Проект, скомпилируемый как для MacOS, так и для Linux. Если пользователь должен был сообщить об ошибке, которая конкретно влияет на сборку MacOS CLI, я мог бы попытаться исправить его. Как пользователь Ubuntu Linux, я могу написать код и даже пересекать, но я действительно не могу проверить его, чтобы убедиться, что исправляет. У меня нет MacOS.
Введите circleci.
Я могу открыть PR с моим исправлением, а Circleci построит и проверим его на машине MacOS. Это удалил технический барьер для меня. Аналогично, CI может снизить трение для людей, желающих открыть PR в вашем проекте.
4. Не требуйте секретов сборки для неразъемных заданий
Когда API токены, SSH-ключей и т. Д. Вовлечены в сборку, Вы не хотите, чтобы эти секреты строительства попадают в неправильные руки . Это понятно. Общественные проекты на Circleci имеют секреты по умолчанию выключили на разветвленные PRS.
У нас есть твоя спина.
То, что вы можете сделать, это приложить усилия, чтобы позволить разветвленным PRS достичь зеленой сборки без этих секретов в первую очередь. Команды, которые полагаются на секреты, должны быть изолированы на собственной рабочих местах или заблокированы логикой Bash. Таким образом, внешний PR сможет запустить тесты, которые Pass и сопровождающий проекта могут прийти и проходить интеграционные тесты или развертывание в Мастер
ветвь или какой-то другой путь.
Заключение
Открытый источник Проект оснащен инструментом CI снижает барьер к входу для взносов при повышении общего качества. Открытый источник так же много о людях, так как это код. Уполномоченные участникам являются счастливее и более продуктивные. Это приносит пользу проекту, что означает, что все выигрывают.
Слияние Circleci предоставляет всем пользователям/проектам бесплатный контейнер сборки. Вы знали, что мы даем Открытый исходный код Проекты, в частности, 4 контейнера ? Все еще бесплатно. Давайте создадим программное обеспечение вместе! .
Оригинал: «https://dev.to/circleci/hey-open-source-maintainers-empower-your-contributors-with-continuous-integration-g8p»