Get Started

Collecting Data

Note: Analytics can currently only be collected from js actions. Support for Docker actions may come in the future.

To start collecting analytics data, install the gh-action-stats npm package as follows

npm i -S gh-action-stats

You can then wrap your main function in the collectStats method as follows to start collecting stats.

const collectStats = require('gh-action-stats');

/**
 * main function, it must not have any parameters
 * The main function can also be an async function
 */
function main() {
	// Your code goes here
  console.log('This is the best GitHub action!');
}

collectStats(main);

Deploy it and run it on github actions to start collecting data.

Login & Dashboard

Login is done through your Github account. You are automatically logged out.

Only Github actions you own can be viewed at this time. The time of last use is displayed and you can access the dashboard for the select action by clicking on the card.

Note: Due to Google Functions cold start, this operation can be a bit slow currently.
Actions List Dashboard Screenshot

Action Dashboard

The action dashboard contains the information of the use of your Action. Aggregate data for total number of runs, individual actors and individual repositories are at the top of your dashboard along with the following graphs:

  • Runs vs Time
  • Individual actors & Individual repos vs Time (individual actors and repo that used the action that specific day)

You also get the raw data in a table at the bottom.

⚠️ Note: Private repos will be marked true in the Repo Private column and the name of the repo will be hashed as to ensure the privacy of the users. You still get access to the name of the organization that uses the action. If your Github account has access to the repo then the name will not be anonymized and Repo Private will be false as it is not private to you.
Actions Dashboard Screenshot

Going further

We are continuing to add to the platform and are open to contributors! You can access the repos here: