GitHub Status Indicators

:discourse2: Summary GitHub Status Indicators adds status indicators to GitHub oneboxes for issues and pull requests. Live information is provided by https://shields.io.
:eyeglasses: Preview Preview on Discourse Theme Creator
:hammer_and_wrench: Repository Link https://github.com/discourse/github-status-theme
:open_book: New to Discourse Themes? Beginner’s guide to using Discourse Themes

Install this theme component

Features

GitHub Status Indicators adds status indicators to GitHub oneboxes for issues and pull requests. Live information is provided by https://shields.io.

For example:


:discourse2: Hosted by us? Theme components are available to use on our Standard, Business, and Enterprise plans.

Last edited by @JammyDodger 2024-06-12T18:39:37Z

Check documentPerform check on document:
23 Likes

I agree with the call of not including this in core onebox, it does technically leak user IP addresses to shield.io.

I do love how it looks though. I wonder if discourse-github should take care of this long term, problem though is that there is enormous amount of work in making this work just right, so for now … the component is good.

10 Likes

Does the github plugin do this now, or is this Theme Component still needed?

This is still a separate theme component. It depends on the third-party shields.io service, so I don’t think we’d want to move it into the discourse-GitHub plugin as-is.

Implementing a similar feature ourselves from scratch is possible, but quite involved (especially when you consider GitHub’s API rate limits)

2 Likes

Can it be used with Shields being self-hosted? They allow anyone to self-host their service with a Creative Commons 0 Public Domain license.

Here is the docker image Docker

1 Like

I think the discussion above was about not wanting to add this theme component’s functionality to the core Discourse code. The reason for that is because it technically leaks a user’s IP address to shield.io. That is why this is a theme component and not a part of the core code.

It can be used on any site, hosted, or self-hosted:

1 Like

I’m confused because Shields can be self-hosted. In that case, wouldn’t the IP not be leaked to shield.io since it is instead being directed to a self-hosted installation?

1 Like

That makes sense. I guess the issue is not wanting to add a shields url to the Discourse site settings. If you wanted to use this theme component with a self-hosted Shields installation, I think you would just need to edit this line to point to your installation instead of to img.shields.io:

1 Like

I think as long as the default remains img.shields.io, adding a theme setting for the server URL would be pr-welcome :+1:

2 Likes