Reportable
Pages 28
General Info
Home
Channels
Installation
Benchable
Bisectable
Bloatable
Committable
Coverable
Evalable
Greppable
Linkable
Nativecallable
Notable
Quotable
Releasable
Reportable
Shareable
Sourceable
Squashable
Statisfiable
Tellable
Undersightable
Unicodable
For Maintainers
Installation (for maintainers)
Testing
Adding New Features
Clone this wiki locally
This is an IRC bot for generating reports of changes in rakudo RT and GitHub issue trackers (which issues were resolved, updated, rejected, etc.). It can be addressed by its full name ('reportable6') or its short name ('report'). It takes snapshots of issue trackers periodically, and then you can ask it to generate a report for two given snapshots.
You can find some extra examples in tests: reportable.t
See also: Weekly, Monthly and Yearly reports
Usage examples
Basics
To list existing snapshots:
<AlexDaniel> reportable6:
list
<reportable6> AlexDaniel, https://gist.github.com/3cb0fc7d9abb05a896b523f728814147
To generate a report:
<AlexDaniel> reportable6:
2017-10-06T02:26:20Z
2017-11-28T12:00:00Z
<reportable6> AlexDaniel, OK, working on it! This may take up to 40 seconds
<reportable6> AlexDaniel, https://gist.github.com/5ea96598fb71770d0972577eefd49caf
You don't have to be very specific (it will use the first snapshot on that day, month, or year):
<AlexDaniel> reportable6:
2017-10-06
2017-11-28
<reportable6> AlexDaniel, OK, working on it! This may take up to 40 seconds
<reportable6> AlexDaniel, https://gist.github.com/5552caf2803bb491aaa9f497e6543a4a
Upcoming commands
These are not implemented yet:
daily
weekly
monthly
yearly
Notes:
2017-10-29T11:13:12Z
is the first snapshot that contains real data from GitHub. Previous snapshots include fake GitHub data that was extrapolated back from it.
Running the bot locally
Generally, the reportable should functional as long as you have at least two snapshots. You can run the bot and let it generate them (will take a few hours for it to trigger at the right time), or you can just grab these:
Put these archives into whateverable/data/reportable
directory (where whateverable/
is project root), and extract them like this:
tar -xvzf ./2018-01-01T00\:00\:00Z.tar.gz
tar -xvzf ./2018-04-01T00\:00\:00Z.tar.gz
Then the bot should be able to generate the report:
<AlexDaniel> reportable6test: 2018-01-01T00:00:00Z 2018-04-01T00:00:00Z
<reportable6test> AlexDaniel, OK, working on it! This may take up to 40 seconds
<reportable6test> AlexDaniel, https://gist.github.com/cb0e4bba3e9c6549f4c414be4841d13b