A small Perl 6 application to start an IRC bot to notify channels of new Perl 6 modules uploaded to CPAN
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Patrick Spek 58dbba4cb8
Use App::CPAN's database instead of parsing nntp.perl.org
1 week ago
bin Bump version to 1.0.1 3 weeks ago
dev-bin Update mkdocker 3 weeks ago
lib/App/CPAN/UploadAnnouncer Use App::CPAN's database instead of parsing nntp.perl.org 1 week ago
.editorconfig Update EditorConfig 3 months ago
.gitignore Initial commit 3 months ago
.gitlab-ci.yml Initial commit 3 months ago
.travis.yml Initial commit 3 months ago
CHANGELOG.md Update the response on .bots 3 weeks ago
Dockerfile Use App::CPAN's database instead of parsing nntp.perl.org 1 week ago
META6.json Use App::CPAN's database instead of parsing nntp.perl.org 1 week ago
Makefile Rename module to App::CPAN::UploadAnnouncer::IRC 3 weeks ago
README.pod6 Use App::CPAN's database instead of parsing nntp.perl.org 1 week ago

README.pod6

=begin pod

=NAME App::CPAN::UploadAnnouncer::IRC
=AUTHOR Patrick Spek <p.spek@tyil.work>
=VERSION 0.0.0

=head1 Description

An IRC bot to notify of new module uploads to CPAN

=head1 Running the bot

=head2 Install dependencies

You can use C<zef> to install the dependencies with ease.

=begin code :lang<sh>
zef install --deps-only .
=end code

=head2 Pick method of configuring the bot

The bot can be configured using command line flags, or environment
variables. You can see which options you have by running C<bot -h>.

=head2 Start the bot

To start the bot, call it using C<perl6> with the C<lib> directory added to the
include path.

=begin code :lang<sh>
PERL6LIB=lib perl6 bin/bot
=end code

If you chose to configure it with command line options instead of environment
variables, you will need to add them at the end.

=head2 Features

=head3 CPAN update notifications

The bot will check a given L<https://git.tyil.nl/perl6/app/cpan|CPAN> database
every minute for new modules, and report them, oldest to newest, to IRC.

=head3 Reporting in!

When C<.bots> is send as a message to a channel the bot is in, it will report
in. This will announce it's presence to the channel, along with it's version
number and the URL where people can find the sources.

=head3 CPAN IRC commands

In addition to the forementioned features, there are also a number of
"commands" that can be sent to the bot on IRC. These need to be prefixed with
it's B<current> username. For instance, if the bot is connected as C<cpan-p6>
and you would like to retrieve the latest module that has been added to the
database, you would need to say C<cpan-p6: recent>.

=head4 C<recent>

Retrieves the latest module that has been added to the CPAN database, and
reports it back to the channel the command was given in.

=head1 License

This module is distributed under the terms of the AGPL-3.0.

=end pod