Introduction

Displays statistics about a public GitHub repository. Allows your team to quickly see at a glance statistics about a repository in GitHub.

It is a simple widget that allows teams that use GitHub as a public repository to see in their dashboard statistics about their repository(ies), for example if there are open issues or if there are open pull requests that need attention.

The widget shows the following data about the repository

• Number of Open Issues
• Number of Closed Issues
• Number of pending Pull Requests
• Number of Releases
• Number of Forks

Configuration

After you install the widget in your account (see Get extensions for Visual Studio Team Services to learn how to install extensions) you need to configure your dashboard(s) to add the widget.

If you are unsure how to configure your dashboard, head up to the official documentation

The widget has three configuration parameters * User The owner of the repository

• Repository After you configure a valid owner, the repository dropdown will be filled with the user public repositories. Pick one
• Cache Duration The number of minutes the data is cached (zero to disable caching)

Caching

The statistics are obtained by calls performed on the user browser, since GitHub applies a rate limit to API calls (the limits are imposed by IP address so a team sharing an office can hit it, pretty fast) the widget supports data caching in order to limit the number of calls made Cached data is stored on Visual Studio Team Services and is shared among all users

Content/script blockers

If you are using content or script blocker that is configured to block everything by default, you may need to configure it to explicitily add permission for two specific sites so the widget can properly work.

Depending on the blocker you are using, you may have more or less configurations options presented here. These are the minimum settings you need so the widgetcan fully functions.

Extension files are hosted on Visual Studio Team Services, but they are hosted under a different domain for security reasons.

The files are hosted on the domain yodlabs.gallery.vsassets.io. Since you may be using other extensions you might as well apply the configuration for the entire vsassets.io domain.

You also need to enable XHR (requests made by the widget) calls to api.github.com, GitHub API is called to fetch statistics directly from GitHub.

The mininum needed permissions are outlined in the table below

Troubleshooting

If you see in the widget the title name "GitHub repository statistics" and the message "Widget failed to load" (see screenshot below) it may mean your blocker is blocking access to yodlabs.gallery.vsassets.io

Some blockers show the number of blocks it has performed right there on the browser toolbar (see some examples below)

Those are the easiest to detect and unblock, just click on the extension icon on the toolbar and configure the domains you wish to unblock.

I've seen some blockers have a zero counter even if they are blocking domains other than the main domain (visualstudio.com in this case). Even if the counter is zero, click on the icon to make sure there are still no domains being blocked.

Other blockers are a little more discrete and don't give you any hint what happened, in that case you can either analyze and configure the blocker to allow the requests that have been summarized before or open your browser developer tools (tipically by pressing F12) and see what is exactly happening. (after opening the tools refresh the browser)

An alternative to the browser tool, is to use the blocker extensions logs. Most of the extensions have a logger tool where you can see sucessfull and blocked calls

On the network tab activity you should see the list of all fetched files and if files from yodlabs.gallery.vsassets.io are being blocke.

Below you can see a screenshot from Chrome developer tools, showing files being blocked for the domain yodlabs.gallery.vsassets.io

If there are no blocked files, then the next probable cause, is the fact the script execution is being blocked for the domain yodlabs.gallery.vsassets.io.

Check your browser developer tool console for errors.

This means script execution is being blocked. Configure your blocker to allow script execution for yodlabs.gallery.vsassets.io or vsassets.io

Even if after you have performed these configurations, you can't configure a user or don't see any data

It may mean calls to api.github.com are being blocked (again check browser developer tools network tab to confirm this).

Configure your blocker to allow calls to api.github.com

This should be enough to unblock and let you use the widget with a blocker.

NoScript Firefox extension

if you are using NoScript on Firefox, it is a lot easier to be aware why the widget is not working.

NoScript adds a warning at the the bottom of the browser window that some scripts have been blocked.

Click on options and select either Allow all this page or allow vsassets.io (see noscript options menu below)

Support

If you find an issue, need help or have improvement suggestions you can do so by emailing [support@yodlabs.com](support@yodlabs.com?subject=GitHub Stats Widget) with "GitHub Stats Widget" as a subject.