automattic / ghactivity

WordPress plugin. Build reports of all your GitHub activity.

Ghactivity

Track your GitHub activity and your team's

How the plugin works

Administration

Plugin's administration happens under Settings > GitHub Activity Settings.

To get started, you'll need to define at least one GitHub username and an access token you can get from GitHub, and that allows to query all activity, including from private repos. Those options are then stored in an array in ghactivity.

That admin page is managed via the admin.ghactivity.php file.

Logs

You probably also noticed the GitHub Events & GitHub Issues menus. Those are added, alongside custom taxonomies, via cpt.ghactivity.php.

Those CPTs and custom taxonomies get filled every hour, based on calls made to the GitHub API using the info you provided in the admin settings.

In addition to monitoring activity for a specific GitHub username, you can also monitor all events for a specific repo. You can activate that for each repo appearing under GitHub Events > Repos.

You can view the calls made to the GitHub API and all functions used to log all the data in core.ghactivity.php.

Working with the data

core.ghactivity.php also includes some functions that query the data to count events. There are 3 main areas where you can call those functions and create reports:

• reports.ghactivity.php, used alongside charts.ghactivity.php to display a chart
• rest.ghactivity.php, where I started adding endpoints to query the data.
• The different shortcodes under the /shortcodes directory.

This is less than ideal and a bit confusing. Instead of doing things in different places like that, I think everything should go via rest.ghactivity.php. I thought we could then build each shortcode to query the API for data, and display it using shared components.

What still needs to be done

Check the issues here to get some ideas.

ghactivity's Issues

Reports: create React components that can be shared by all shortcodes

I started working on building a react environment for all shortcodes:
https://github.com/jeherve/ghactivity/blob/master/webpack.config.js#L7
https://github.com/jeherve/ghactivity/tree/master/shortcodes/js

It would allow us to have shared components to display data we return for REST API queries:
https://github.com/jeherve/ghactivity/blob/master/rest.ghactivity.php

It would then be easier to create graphs and tables without having to build it again for each shortcode.

Teams: allow people to be a member of multiple teams

The team interface currently only allows you to be part of one team at a time:

It would be nice to switch to a list of checkboxes, so one can be a member of multiple teams at the same time. This would allow us to build reports for teams but also for squads inside a team (like Dash).

Average Label Time: Display list of the issues

Requested by @chaselivingston in p9dueE-ly-p2:

Would it be possible to see a report of individual issues and how long each of them has been labeled with that label? In essence, I’d like to be able to track how long any one issue has waited for a dev to look at it.

Should be easily archivable by updating fetch_average_label_time to include record_slugs meta in return value, and then render that list in UI

average_label_time shortcode: Add DB query caching

Since average_label_time is fetching DB on every page load we need to add caching to make things faster (and safer)

Average Label Time: Make it possible to add multiple graphs on same page

Right now we use wp_localize_script( 'ghactivity-average-label-time', 'ghactivity_avg_label_time', $args ); to share some of the relevant data with JavaScript. This approach will not work with multiple shortcodes on the same page. We need to fix that at some point

Repo activity: create repo activity shortcode

I started working on that shortcode here:
https://github.com/jeherve/ghactivity/blob/8633d8c5b3599dad4c13d8f030422222aa41c487/shortcodes/repo-activity.php

It is not currently included anywhere though.

Ideally that shortcode would display a table or a graph of issues and PRs created, triaged, closed, merged, with the option to see average ages for each action performed.

ghactivity_team shortcode: fix so it can display info for teams

https://github.com/jeherve/ghactivity/blob/master/shortcodes/team-activity.php

The shortcode does not currently work, it would need to be fixed.
We also have the opportunity to get rid of a lot of duplicate code, that already exists in https://github.com/jeherve/ghactivity/blob/master/reports.ghactivity.php

Feature Request Data: VaultPress-specific jpop-issues

I'd like to be able to see the following information about the jpop-issues labeled VaultPress:

• Average time with needs dev triage label
• Open/Close ratio of issues in the last month/week

Get person's details: do not grab details from the wrong GitHub username

The get_person_details function currently makes a call to the GitHub API to get information about each tracked user, and store that information in term meta:
https://github.com/jeherve/ghactivity/blob/8633d8c5b3599dad4c13d8f030422222aa41c487/core.ghactivity.php#L139
https://github.com/jeherve/ghactivity/blob/8633d8c5b3599dad4c13d8f030422222aa41c487/core.ghactivity.php#L557

This works well for most people, but not for folks like @oskosk. We need to fix this so it grabs data based on the GitHub username, not display name. I have not investigated yet, but we may need to review how we generate the terms in the ghactivity_actor taxonomy in the first place.

Create "State of repo" page

"State of repo" page should include:

• graph / table of "Open issues by type"
• graph / table of "Open issues by priority"
• graph / table of "Open issues by their status"
• graph / table of "Open issues by Area"

Maybe list some issues, for example:

• 2-3 oldest PRs
• 2 oldest stalled issues
• few issues with most comments count
  etc

Issues tracking: improve how labels are stored for each issue

Right now, we log the labels currently existing for each issue, but we don't log the history of the labels and how they changed over time.

It would be nice if we could store:

• when a label was added.
• when it was removed.

This would allow us to make queries to retrieve information like:

• How many issues were opened last month?
• How many issues were closed last month?
• How many issues were marked as needing dev triage?
• How many issues were marked as needing Dash?
• How many issues were triaged?
• How many were not?
• What’s the average age of issues, or of a subset of issues (like issues needing triage or review)?
• On average how long do we have to wait for an issue to be triaged?

Charts: refactor the way chart data is added to each chart

When I started working on the plugin, my idea was to have a central place where the chart js was enqueued:
https://github.com/jeherve/ghactivity/blob/master/charts.ghactivity.php

And then feed the data for each chart with filters:
https://github.com/jeherve/ghactivity/blob/master/charts.ghactivity.php#L68
https://github.com/jeherve/ghactivity/blob/master/reports.ghactivity.php#L24

This may not be the best approach as we add more places and shortcodes where the charts can be displayed, with different data needed in each.