From Fedora Project Wiki

(Add swbug function)
m (more grammar...)
(37 intermediate revisions by 14 users not shown)
Line 1: Line 1:
'''zodbot''' is a [ supybot http://sourceforge.net/projects/supybot/ ] instance connected to the irc.freenode.net IRC network and joined to many [[Communicate#IRC|Fedora-related IRC channels]].
'''Zodbot''' is a [http://sourceforge.net/projects/supybot/ supybot] instance connected to the irc.freenode.net IRC network and joined to many [[Communicate#IRC|Fedora-related IRC channels]].


zodbot runs on the noc1.fedoraproject.org host, hosted by Fedora infrastructure.  
Zodbot runs on the value01.fedoraproject.org host, hosted by Fedora infrastructure.  


This page describes what zodbot does and how it can be used by those with the permissions to operate it.  
This page describes what zodbot does and how it can be used by those with the permissions to operate it. Most functions do not require any special permissions. Those the do are noted as such.


== Addressing zodbot ==  
== Addressing zodbot ==  


zodbot watches for . as it's prefix, so if you want to query it in a channel, you will need to add . to the beginning of any of the listed commands below.  
Zodbot watches for . as its prefix, so if you want to query it in a channel, you will need to add . to the beginning of any of the listed commands below.  
If you wish to avoid chatter in channel from zodbot, you can address zodbot directly.  You may wish to do this in channels with a large number of users or if you have a number of queries.  For example:
If you wish to avoid chatter in channel from zodbot, you can address zodbot directly.  You may wish to do this in channels with a large number of users or if you have a number of queries.  For example:


Line 20: Line 20:
== Fedora-specific functions ==
== Fedora-specific functions ==


* '''badges''' ''username'' (badges)
:: Returns the number of Fedora Badges held by a user.
* '''branches''' ''package_name'' (pkgdb)
* '''branches''' ''package_name'' (pkgdb)
:: Returns the branches of a package.
:: Returns the branches of a package.
* '''bug''' ''bug_number'' (RH bugzilla)
* '''bug''' ''bug_number'' (RH bugzilla)
:: Return the name and URL of a Red Hat Bugzilla ticket.
:: Return the name and URL of a Red Hat Bugzilla ticket.
* '''ext''' ''account_name'' (fas)
:: Return the talk.fedoraproject.org extension number for a Fedora Account System username.
* '''fas''' ''query'' (fas)
* '''fas''' ''query'' (fas)
:: Searches the Fedora Account System database in usernames, emails, full names, and IRC nicks. (Note that some accounts have enabled privacy, so nothing but their FAS username will be searchable.)
:: Searches the Fedora Account System database in usernames, emails, full names, and IRC nicks. (Note that some accounts have enabled privacy, so nothing but their FAS username will be searchable.)
Line 36: Line 36:
* '''members''' ''group_name'' (fas)
* '''members''' ''group_name'' (fas)
:: Return a list of members of the specified group.
:: Return a list of members of the specified group.
* '''nextmeeting''' ''channel_name'' (fedocal)
:: Return the next meeting scheduled to occur in a given channel.
* '''nextmeetings'''
:: Return the next 5 scheduled meetings in any channel.
* <s>'''pingall''' ''message''
:: Ping everyone in the IRC channel.</s>
{{admon/note | Use pinglist instead | Pinglist allows people to opt-in instead. Refer to [http://ur1.ca/3d7yo the instructions] for more information.}}
* '''pulls''' ''organization/repository''
:: Return the list of open pull requests on a GitHub repository.
* '''pulls''' ''organization''
:: Return the list of open pull requests on all repositories on a GitHub organization.
* '''pushduty'''
:: List who is currently on updates-push duty for Release Engineering.
* '''quote''' ''symbol'' ''period'' (fedmsg)
:: Return statistics on fedmsg activity for different services.
* '''refresh'''
* '''refresh'''
:: Refresh the necessary caches.
:: Refresh the necessary caches. '''''This requires special permissions'''''
* '''sponsors''' ''group_name'' (fas)
* '''sponsors''' ''group_name'' (fas)
:: Provides a list of sponsors for an exact group name, with @ indicating administrators of the group.
:: Provides a list of sponsors for an exact group name, with @ indicating administrators of the group.
* '''swbug''' ''bug_number'' (SW bugzilla)
* '''swbug''' ''bug_number'' (SW bugzilla)
::  Return the name and URL of a Sourceware Bugzilla ticket.
::  Return the name and URL of a Sourceware Bugzilla ticket.
* '''swedish''' (zodbot)
:: Bot version. (Humor mmcgrath.)
* '''ticket''' ''ticket_number'' (infrastructure)
:: Return the name and URL of a Fedora Infrastructure ticket.
* '''vacation'''
:: Returns the list of who is currently on vacation according to [https://apps.fedoraproject.org/calendar fedocal].
* '''what''' ''package_name'' (pkgdb)
* '''what''' ''package_name'' (pkgdb)
:: Returns a description of a package.
:: Returns a description of a package.
* '''whoowns''' ''package_name'' (pkgdb)
* '''whoowns''' ''package_name'' (pkgdb)
:: Returns the FAS account of the owner of a package.
:: Returns the FAS account of the owner of a package. To get directly the fasinfo of the owner, you can use: '''fasinfo <nowiki>[</nowiki>whoowns''' ''package_name''''']'''
* '''wikilink''' ''account_name'' (fas)
:: Return MediaWiki link syntax for a FAS user's page on the wiki.


== Koji-specific functions ==   
== Koji-specific functions ==   
Line 56: Line 79:
== Meeting Functions ==
== Meeting Functions ==


zodbot has the supybot-meetbot plugin package installed and configured. See: [http://wiki.debian.org/MeetBot the MeetBot wiki page] for more information on the meeting commands. Meeting logs will be at [ http://meetbot.fedoraproject.org ].  
Zodbot has the supybot-meetbot plugin package installed and configured. See: [http://wiki.debian.org/MeetBot the MeetBot wiki page] for more information on the meeting commands. Meeting logs will be at [http://meetbot.fedoraproject.org meetbot.fedoraproject.org].
 
The implementation of meetbot used by the Fedora project is kept in the Fedora and EPEL repositories and can be installed with 'su -c dnf install supybot-meetbot'. This will install both the meetbot plugin and the supybot base code, as needed.
 
To work with the supybot code you would need to install the fedpkg command. How to use it and how to gain access to Fedora maintained packages can be found elsewhere on this wiki.  


In general for meetings using the plugin, you will want to use this sequence of commands:  
In general for meetings using the plugin, you will want to use this sequence of commands:  


* #startmeeting - start the meeting.  
* #startmeeting <meeting name> - Start the meeting. A value for <meeting name> is required to start a meeting (as it will be used to name and organize the logs), or the meeting will not be started and will not be logged. It can be changed later if needed. The meeting will still be organized by the initial meeting name value given when the meeting was started.
* #meetingtopic <topic> - overall meeting topic (example: FESCo meeting)
* #meetingname <meeting-name> - Usually the name of the team meeting (example: fesco). Not required, but it can be used to change the name of the meeting in the IRC channel at any time. It will not change the log name.
* #topic <currenttopic> - Use topic to go through each of the topics in your adgenda. The main meetingtopic will stay the same.
* #meetingtopic <topic> - Overall meeting topic (example: FESCo meeting) Not required. May be useful to meetings that have many topics and where the group may find it helpful to call out topics as a method of organizing the meeting in the logs.
* #info, #help, #agreed, #denied, etc - as needed in the meeting.  
* #topic <currenttopic> - Use topic to go through each of the topics in your agenda. The main meetingtopic will stay the same.
* #endmeeting
* #action, #accepted, #agreed, #chair, #idea, #info, #link, #rejected, etc. - as needed in the meeting. (#commands will provide a full list of available commands.)
* #endmeeting - Ends the meeting and presents the log links in the IRC channel


Zodbot also has some aliases setup to list the time until various meetings:  
Zodbot also has some aliases setup to list the time until various meetings:  
Line 70: Line 98:
nextfescomeeting, nextkdemeeting, nextepelmeeting, nextinframeeting, nextrelengmeeting, etc.  
nextfescomeeting, nextkdemeeting, nextepelmeeting, nextinframeeting, nextrelengmeeting, etc.  
These commands will list the time until the next meeting of that sig or group.  
These commands will list the time until the next meeting of that sig or group.  
=== Meeting admin commands ===
These all require special permissions to run.
* '''addchair''' ''channel'' freenode ''nick'' - Add a chair to a meeting. Useful if you need to end a meeting that someone has going in a channel that they forgot to end.
* '''listmeetings''' - list the currently in-progress meetings
* '''deletemeeting''' ''channel'' freenode - used to end a meeting. Contrary to the name, it saves the meeting first, unless you specify False as the last parameter
* '''recent''' - list recent meetings
* '''savemeetings''' - save all currently active meetings
=== Zodbot blew up while it was logging my meeting, what can I do? ===
First, go to [http://meetbot.fedoraproject.org/ meetbot.fedoraproject.org] and find the incomplete log of your meeting. Then extract the remainder of the log from your IRC client and save that to a text file. The log must end with somebody saying "#endmeeting". ''Please do not upload HTMLified logs.''
Go to the [https://fedorahosted.org/fedora-infrastructure Fedora Infrastructure Trac], login with your FAS account, and click "New Ticket" at the top. Mention that your meeting log is incomplete and the meetbot.fedoraproject.org URL of the incomplete log. Also include the URL for the [[Zodbot Infrastructure SOP]] for the convenience of the person processing the ticket. Click "I have files to attach to this ticket," then click "Submit ticket." Attach the remainder of the log.
{{admon/note | Example ticket | Please make your ticket as similar to [https://fedorahosted.org/fedora-infrastructure/ticket/2213 ticket 2213] as possible. }}


== Other useful commands ==
== Other useful commands ==


* seen <nick> - returns the last time nick was seen in that channel and what they were saying.  
* seen <nick> - returns the last time nick was seen in that channel and what they were saying.  
* any <nick> - returns the last time nick was in any channel zodbot is in and what they were saying.  
* any <nick> - returns the last time nick was in any channel zodbot is in and what they were saying.
 
== Source code ==
 
The source code for the Fedora extensions are available in the [https://github.com/fedora-infra/supybot-fedora supybot-fedora GitHub repository].
 
== Additional Reading ==
 
More general information on supybot can be found in the excellent [http://supybook.fealdia.org/devel/ supybook].  


== Contact ==
== Contact ==


For any questions about zodbot, please ask in #fedora-admin.
For any questions about zodbot, please ask in #fedora-admin.
Bugs and feature requests can also be reported in the [https://fedorahosted.org/fedora-infrastructure/newticket Fedora Infrastructurce trac] using the component ''General''.

Revision as of 01:15, 15 March 2016

Zodbot is a supybot instance connected to the irc.freenode.net IRC network and joined to many Fedora-related IRC channels.

Zodbot runs on the value01.fedoraproject.org host, hosted by Fedora infrastructure.

This page describes what zodbot does and how it can be used by those with the permissions to operate it. Most functions do not require any special permissions. Those the do are noted as such.

Addressing zodbot

Zodbot watches for . as its prefix, so if you want to query it in a channel, you will need to add . to the beginning of any of the listed commands below. If you wish to avoid chatter in channel from zodbot, you can address zodbot directly. You may wish to do this in channels with a large number of users or if you have a number of queries. For example:

/msg zodbot whoowns fedora-release

for a single query, or

/query zodbot whoowns fedora-release

for an extended conversation.

Fedora-specific functions

  • badges username (badges)
Returns the number of Fedora Badges held by a user.
  • branches package_name (pkgdb)
Returns the branches of a package.
  • bug bug_number (RH bugzilla)
Return the name and URL of a Red Hat Bugzilla ticket.
  • fas query (fas)
Searches the Fedora Account System database in usernames, emails, full names, and IRC nicks. (Note that some accounts have enabled privacy, so nothing but their FAS username will be searchable.)
  • fasinfo account_name (fas)
Provides detailed Fedora Account System information about the specific account name. This requires an exact username.
  • fesco ticket_number (fesco)
Return the name and URL of a FESCo ticket.
  • group group_name (fas)
Return information about a Fedora Account System group.
  • members group_name (fas)
Return a list of members of the specified group.
  • nextmeeting channel_name (fedocal)
Return the next meeting scheduled to occur in a given channel.
  • nextmeetings
Return the next 5 scheduled meetings in any channel.
  • pingall message
Ping everyone in the IRC channel.
Note.png
Use pinglist instead
Pinglist allows people to opt-in instead. Refer to the instructions for more information.
  • pulls organization/repository
Return the list of open pull requests on a GitHub repository.
  • pulls organization
Return the list of open pull requests on all repositories on a GitHub organization.
  • pushduty
List who is currently on updates-push duty for Release Engineering.
  • quote symbol period (fedmsg)
Return statistics on fedmsg activity for different services.
  • refresh
Refresh the necessary caches. This requires special permissions
  • sponsors group_name (fas)
Provides a list of sponsors for an exact group name, with @ indicating administrators of the group.
  • swbug bug_number (SW bugzilla)
Return the name and URL of a Sourceware Bugzilla ticket.
  • swedish (zodbot)
Bot version. (Humor mmcgrath.)
  • ticket ticket_number (infrastructure)
Return the name and URL of a Fedora Infrastructure ticket.
  • vacation
Returns the list of who is currently on vacation according to fedocal.
  • what package_name (pkgdb)
Returns a description of a package.
  • whoowns package_name (pkgdb)
Returns the FAS account of the owner of a package. To get directly the fasinfo of the owner, you can use: fasinfo [whoowns package_name]
  • wikilink account_name (fas)
Return MediaWiki link syntax for a FAS user's page on the wiki.

Koji-specific functions

  • builders - returns a list of build machines enabled and disabled.
  • building <builder> - returns what is building on builder number <builder>
  • taskload - lists number of current koji tasks.
  • buildload - lists load on all koji build cluster.

Meeting Functions

Zodbot has the supybot-meetbot plugin package installed and configured. See: the MeetBot wiki page for more information on the meeting commands. Meeting logs will be at meetbot.fedoraproject.org.

The implementation of meetbot used by the Fedora project is kept in the Fedora and EPEL repositories and can be installed with 'su -c dnf install supybot-meetbot'. This will install both the meetbot plugin and the supybot base code, as needed.

To work with the supybot code you would need to install the fedpkg command. How to use it and how to gain access to Fedora maintained packages can be found elsewhere on this wiki.

In general for meetings using the plugin, you will want to use this sequence of commands:

  • #startmeeting <meeting name> - Start the meeting. A value for <meeting name> is required to start a meeting (as it will be used to name and organize the logs), or the meeting will not be started and will not be logged. It can be changed later if needed. The meeting will still be organized by the initial meeting name value given when the meeting was started.
  • #meetingname <meeting-name> - Usually the name of the team meeting (example: fesco). Not required, but it can be used to change the name of the meeting in the IRC channel at any time. It will not change the log name.
  • #meetingtopic <topic> - Overall meeting topic (example: FESCo meeting) Not required. May be useful to meetings that have many topics and where the group may find it helpful to call out topics as a method of organizing the meeting in the logs.
  • #topic <currenttopic> - Use topic to go through each of the topics in your agenda. The main meetingtopic will stay the same.
  • #action, #accepted, #agreed, #chair, #idea, #info, #link, #rejected, etc. - as needed in the meeting. (#commands will provide a full list of available commands.)
  • #endmeeting - Ends the meeting and presents the log links in the IRC channel

Zodbot also has some aliases setup to list the time until various meetings:

nextfescomeeting, nextkdemeeting, nextepelmeeting, nextinframeeting, nextrelengmeeting, etc. These commands will list the time until the next meeting of that sig or group.

Meeting admin commands

These all require special permissions to run.

  • addchair channel freenode nick - Add a chair to a meeting. Useful if you need to end a meeting that someone has going in a channel that they forgot to end.
  • listmeetings - list the currently in-progress meetings
  • deletemeeting channel freenode - used to end a meeting. Contrary to the name, it saves the meeting first, unless you specify False as the last parameter
  • recent - list recent meetings
  • savemeetings - save all currently active meetings

Zodbot blew up while it was logging my meeting, what can I do?

First, go to meetbot.fedoraproject.org and find the incomplete log of your meeting. Then extract the remainder of the log from your IRC client and save that to a text file. The log must end with somebody saying "#endmeeting". Please do not upload HTMLified logs.

Go to the Fedora Infrastructure Trac, login with your FAS account, and click "New Ticket" at the top. Mention that your meeting log is incomplete and the meetbot.fedoraproject.org URL of the incomplete log. Also include the URL for the Zodbot Infrastructure SOP for the convenience of the person processing the ticket. Click "I have files to attach to this ticket," then click "Submit ticket." Attach the remainder of the log.

Note.png
Example ticket
Please make your ticket as similar to ticket 2213 as possible.

Other useful commands

  • seen <nick> - returns the last time nick was seen in that channel and what they were saying.
  • any <nick> - returns the last time nick was in any channel zodbot is in and what they were saying.

Source code

The source code for the Fedora extensions are available in the supybot-fedora GitHub repository.

Additional Reading

More general information on supybot can be found in the excellent supybook.

Contact

For any questions about zodbot, please ask in #fedora-admin.

Bugs and feature requests can also be reported in the Fedora Infrastructurce trac using the component General.