view release on metacpan or  search on metacpan

lib/App/GitHubWebhooks2Ikachan.pm  view on Meta::CPAN

App::GitHubWebhooks2Ikachan - Web server to notify GitHub Webhooks to L<App::Ikachan>

=head1 SYNOPSIS

    $ githubwebhooks2ikachan --ikachan_url=http://your-ikachan-server.com/notice --port=12345

=head1 DESCRIPTION

App::GitHubWebhooks2Ikachan is the server to notify GitHub Webhooks to L<App::Ikachan>.

Now, this application supports C<issues>, C<pull_request>, C<issue_comment>, C<commit_comment>, C<pull_request_review_comment> and C<push> webhooks of GitHub.

=head1 PARAMETERS

Please refer to the L<githubwebhooks2ikachan>.

=head1 USAGE

Please set up webhooks at GitHub (if you want to know details, please refer L<http://developer.github.com/v3/activity/events/types/>).

Payload URL will be like so;

    http://your-githubwebhooks2ikachan-server.com/${path}?subscribe=issues,pull_request&issues=opened,closed&pull_request=opened

This section describes the details.

=over 4

=item PATH INFO

=over 8

=item ${path}

Destination of IRC channel or user to send message. This is essential.
If you want to send C<#foobar> channel, please fill here C<%23foobar>.

=back

=item QUERY PARAMETERS

=over 8

=item subscribe

Event names to subscribe. Specify by comma separated value.
Now, this application supports C<issues>, C<pull_request>, C<issue_comment>, and C<push>.

If you omit this parameter, it will subscribe the all of supported events.

=item issues

Action names to subscribe for C<issues> event. Specify by comma separated value.
Now this application supports C<opened>, C<closed>, and C<reopend>.

If you omit this parameter, it will subscribe the all of supported actions of C<issues>.

=item pull_request

Action names to subscribe for C<pull_request> event. Specify by comma separated value.
Now this application supports C<opened>, C<closed>, C<reopend>, and C<synchronize>.

If you omit this parameter, it will subscribe the all of supported actions of C<pull_request>.

=back

=back

=head1 SEE ALSO

L<githubwebhooks2ikachan>

L<http://developer.github.com/v3/activity/events/types/>.

=head1 LICENSE

Copyright (C) moznion.

This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.

=head1 AUTHOR

moznion E<lt>moznion@gmail.comE<gt>

=cut