Робот Github

Github robot

Заявление

Данный репозиторий @xuexb/github-bot служит для демонстрации основных функций github-бота, поскольку конкретные функции, которые необходимо реализовать, могут различаться в зависимости от проекта. Если вам нужен бот, вы можете сделать форк и добавить или удалить необходимые функции. Ниже приведены некоторые часто используемые функции.

Функции — Feature

Issue

— [x] Issues, созданные не через страницу создания issue, будут автоматически закрыты. — [x] Issue автоматически получает соответствующий label в соответствии с типом, указанным на странице создания. — [x] При присвоении issue label «need demo» бот автоматически отвечает, что требуется соответствующая демонстрация. — [x] Issue автоматически назначается определённому пользователю, при этом необходимо настроить отображение в package.json config.github-bot.labelToAuthor.

Pull Request

— [x] PR автоматически добавляет указанного reviewer при использовании соответствующего label, необходимо настроить отображение в package.json config.github-bot.labelToAuthor. — [x] В случае несоответствия заголовка PR правилам, бот уведомляет о необходимости изменения, для этого необходимо настроить отображение в package.json config.validate-commit-msg.type. Заголовок должен начинаться с ключевого слова функции. — [x] Бот автоматически присваивает соответствующие labels в зависимости от префикса в заголовке PR. Например, «feat» преобразуется в «enhancement», а «fix» — в «bug».

Release

— [x] При первом отправке новой версии на удалённый сервер бот автоматически выводит список изменений между текущей версией и предыдущей и публикует release notes. Поскольку для сравнения используются два tag, первый tag не обрабатывается.

Правила — Rules

Правила для issue

Необходимо использовать страницу создания issue для отправки issue, иначе они будут автоматически закрыты.

Правила использования labels

• invalid — неопределён или содержит некорректное содержимое;
• need demo — требуется предоставить ссылку на предварительный просмотр;
• need update — требуется обновление для исправления проблемы;
• bug — ошибка;
• duplicate — дубликат;
• enhancement — новая функция;
• question — вопрос;
• wontfix — проблема, которая не будет исправлена.

Правила оформления commit log и PR

Все заголовки должны начинаться со слов «функциональное ключевое слово:».

См.: http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html

Функциональные ключевые слова включают:

• feat — новая функция (feature);
• fix — исправление ошибки;
• docs — документация (documentation);
• style — форматирование (изменения, не влияющие на выполнение кода);
• test — добавление тестов;
• chore — изменения в процессе сборки или вспомогательных инструментах;
• revert — отмена изменений;
• close — закрытие issue.

Пример:

close: #1, #3
feat: добавление функции xx
docs: обновление информации об установке

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

1. Создание access tokens

https://github.com/settings/tokens (необходимо настроить в .env).

2. Создание webhook

https://github.com/用户名/项目名/settings/hooks/new

— Payload URL: www.example.com:8000; — Content type: application/json; — trigger: Send me everything; — Secret: xxx (необходимо настроить в .env).

3. Запуск сервера

npm install
cp env .env
vim .env
npm start

Contributors

Руководство по вкладу пользователей.

— @yugasun; — @xuexb.

Лицензия

MIT