{"id":20049722,"url":"https://github.com/scriptkitties/perl6-irc-client-plugin-github","last_synced_at":"2025-06-13T07:38:58.418Z","repository":{"id":80058690,"uuid":"103184185","full_name":"scriptkitties/perl6-IRC-Client-Plugin-Github","owner":"scriptkitties","description":"A plugin for Github functionality in IRC::Client projects","archived":false,"fork":false,"pushed_at":"2017-10-05T17:50:47.000Z","size":29,"stargazers_count":2,"open_issues_count":2,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-12T20:46:13.621Z","etag":null,"topics":["github-webhooks","irc","irc-bot","perl6"],"latest_commit_sha":null,"homepage":null,"language":"Perl 6","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scriptkitties.png","metadata":{"files":{"readme":"readme.adoc","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-09-11T20:23:33.000Z","updated_at":"2017-12-21T21:29:16.000Z","dependencies_parsed_at":null,"dependency_job_id":"a838b2cf-09c3-4270-b2c9-3385e45792a8","html_url":"https://github.com/scriptkitties/perl6-IRC-Client-Plugin-Github","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scriptkitties%2Fperl6-IRC-Client-Plugin-Github","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scriptkitties%2Fperl6-IRC-Client-Plugin-Github/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scriptkitties%2Fperl6-IRC-Client-Plugin-Github/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scriptkitties%2Fperl6-IRC-Client-Plugin-Github/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scriptkitties","download_url":"https://codeload.github.com/scriptkitties/perl6-IRC-Client-Plugin-Github/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241479891,"owners_count":19969528,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github-webhooks","irc","irc-bot","perl6"],"created_at":"2024-11-13T11:51:59.718Z","updated_at":"2025-03-02T08:26:12.314Z","avatar_url":"https://github.com/scriptkitties.png","language":"Perl 6","funding_links":[],"categories":[],"sub_categories":[],"readme":"= IRC::Client::Plugin::Github\n:toc: preamble\n\nA plugin for Github functionality in IRC::Client projects.\n\n== Features\nThis module is currently only handling Github notifications through the webhook\nsystem.\n\n=== Notifications through Github webhooks\nUsing https://github.com/Bailador/Bailador[Bailador] as webserver, the plugin\ncan act upon Github webhook calls. This means immediate notifications whenever\nsomething happens on a configured repository.\n\n== Usage\n\nInstall the module through https://github.com/ugexe/zef[zef]:\n\n----\nzef install IRC::Client::Plugin::Github\n----\n\nSample setup for an `IRC::Client` project using `IRC::Client::Plugin::Github`:\n\n[source,perl6]\n----\nuse Config;\nuse IRC::Client;\nuse IRC::Client::Plugin::Github;\n\nsub MAIN\n{\n\tmy Config $config = Config.new;\n\n\t.run with IRC::Client.new(\n\t\t:nick\u003cshithub\u003e,\n\t\t:plugins(\n\t\t\tIRC::Client::Plugin::Github.new(config =\u003e $config)\n\t\t)\n\t);\n}\n----\n\n=== Configuration\nConfiguration is done using https://github.com/scriptkitties/p6-Config[Config].\n\nMy preferred way of configuration is with `toml` files, so that's what I'll use\nhere to layout the configuration options. If you want to use another style,\nadapt as necesary and make sure there's a parser available and installed to use\nwith `Config`.\n\n[source,toml]\n----\n# Set this to true to get more output on reasons why things might not be\n# working for you.\ndebug = false\n\n# General configuration of the plugin\n[github.webhook]\n\n# Which IP to bind Bailador to.\nhost = \"0.0.0.0\"\n\n# Which port to bind Bailador to.\nport = 8000\n\n# Set the message-style to \"notice\" to send notices instead of PRIVMSGs\nmessage-style = \"privmsg\"\n\n# The default channels to send to. If no channels are configured on the\n# repository's configuration key, this array will be used instead.\nchannels = [\"#scriptkitties\"]\n\n# If set to true, it will notify for every repository that POSTs a payload to\n# the Bailador instance. Note this could be abused to spam through the bot.\n# When false, every repository should be properly defined if you want to see\n# any notifications from it.\nallow-unknown = false\n\n# Every repository must be configured with a heading similar like this,\n# \"github.webhook.repos.\u003crepo-name\u003e\", where the repo name is the `full-name`\n# attribute on the `repository` key from the webhook payload. Every \"/\" in the\n# `full-name` must be converted to a \"-\", in order to play nice with toml.\n[github.webhook.repos.scripkitties-perl6-IRC-Client-Plugin-Github]\n\n# An array of channels to post notifications in. Overrides the\n# `default-channels` from `github.webhook` if set.\nchannels = [\"#scriptkitties\"]\n----\n\n== License\nThis sourcecode is distributed under the GPLv3 license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscriptkitties%2Fperl6-irc-client-plugin-github","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscriptkitties%2Fperl6-irc-client-plugin-github","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscriptkitties%2Fperl6-irc-client-plugin-github/lists"}