#34: added docs for Hooks

This commit is contained in:
Vokhmin Alexey V 2013-05-16 12:45:27 +04:00
parent 62b58cc62d
commit 68f402e400
9 changed files with 70 additions and 5 deletions

View File

@ -0,0 +1,23 @@
:markdown
1. `server` - IRC server, IE. irc.freenode.net
2. `port` - Normally 6667 (No SSL) or 9999 (SSL) (optional). These are the defaults based on whether the value of `ssl` checkbox.
3. `room` - Supports single or multiple rooms (comma separated). Also supports room passwords (room_name::password). Prefixing '#' to the room is optional.
4. `password` - Server password (optional)
5. `nick` - Nickname (optional)
6. `long_url` - If enabled, displays full compare/commit url's. If disabled uses git.io.
7. `message_without_join` - If enabled prevents joining and immediately leaving the channel.
8. `no_colors` - Disables color support for messages
9. `notice` - Enables notice support. Make sure you configure channel to support notices ("/mode #yourchannelname -n" or "/msg chanserv set mlock -n")
10. `branch_regexes` - Regular expressions for branch name matching (optional, comma separated). For example, only master => `^master$`, master & starts with bug => `master,^bug`.
11. Configure your IRC channel to allow external messages (/mode #yourchannelname -n).
For freenode, try the following:
# server: irc.freenode.net
# port: 6667
# room: #yourroom
# message_without_join: checked
# long_url: checked
# notice: checked
# NOTE: Ensure you enable notice support (see above)

View File

@ -0,0 +1,23 @@
:markdown
1. `server` - IRC сервер, например irc.freenode.net
2. `port` - Стандартный 6667 (без SSL) или 9999 (SSL) (опционально). Это значения по умолчанию в зависимости от значения `ssl` чекбокса.
3. `room` - Поддержка одной или нескольких комнат (через запятую). Также поддерживается пароль к комнате (room_name::password). Префикс '#' у комнаты опционально.
4. `password` - пароль к серверу (опционально)
5. `nick` - никнейм (опционально)
6. `long_url` - Если включено, показывает полные compare/commit url's. Если отключено, использует git.io.
7. `message_without_join` - Если включено, предварительно заходит на канал и немедленно покидает его.
8. `no_colors` - Отключает поддержку цветов для сообщений
9. `notice` - Включает поддержку уведомлений. Убедитесь, что ваш канал поддерживает уведомления ("/mode #yourchannelname -n" или "/msg chanserv set mlock -n")
10. `branch_regexes` - Регулярное выражение для фильтрации по имении ветки (опционально, через запятую). Например, только master => `^master$`, master & начинающиеся на bug => `master,^bug`.
11. Сконфигурируйте ваш IRC канал на поддержку внешних сообщений (/mode #yourchannelname -n).
Для freenode, подходит следующее:
# server: irc.freenode.net
# port: 6667
# room: #yourroom
# message_without_join: checked
# long_url: checked
# notice: checked
# ЗАМЕЧАНИЕ: Убедитесь, что поддержка уведомлений включена (см. выше)

View File

@ -0,0 +1,4 @@
:markdown
1. **User** is the Jabber ID (e.g.: myusername@jabber.org). Multiple users can be added by separating them with commas. Currently, there is a maximum of 25 users.
2. You should add `abf-notification@rosalab.ru` user into your contact list.

View File

@ -0,0 +1,4 @@
:markdown
1. **User** это Jabber ID (например: myusername@jabber.org). Несколько пользователей могут быть добавленны через запятую (максимум 25 пользователей).
2. Вы должны добавить `abf-notification@rosalab.ru` пользователя в ваш список контактов.

View File

@ -0,0 +1,3 @@
:markdown
Well hit these URLs with POST requests when you push to us, passing along information about the push.

View File

@ -0,0 +1,3 @@
:markdown
Мы будем отправлять POST запрос на эти URLs когда вы обновите проект, передавая информацию об обновлении.

View File

@ -8,3 +8,6 @@
= render 'form'
.actions
= f.submit t('layout.update')
%br
= render "projects/hooks/docs/#{@hook.name}"

View File

@ -8,3 +8,6 @@
= render 'form'
.actions
= f.submit t('layout.create')
%br
= render "projects/hooks/docs/#{@hook.name}"

View File

@ -46,10 +46,9 @@ module Modules::Models::WebHooks
password :password
boolean :ssl, :message_without_join, :no_colors, :long_url, :notice
end
# temporarily disabled
# add_hook :jabber do
# string :user
# end
add_hook :jabber do
string :user
end
SCHEMA.freeze
NAMES.freeze