GitHub Status Indicators

david · October 8, 2019, 11:50am


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

Install this theme component

For example:

sam · October 14, 2019, 1:52am

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.

nathank · May 10, 2023, 6:30pm

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

david · May 10, 2023, 8:49pm

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)

sunjam · September 20, 2023, 3:16pm

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

simon · September 21, 2023, 7:46pm

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:

sunjam · September 21, 2023, 9:19pm

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?

simon · September 21, 2023, 9:24pm

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:

github.com

discourse/github-status-theme/blob/ebfe3fa1a5bcfa00f49d2a141bb0623f7fadc666/javascripts/discourse/initializers/initialize-github-status.js#L39


      
              );
              if (!parts) {
                return;
              }
          
              let linkType = parts[3];
              if (linkType === "pull") {
                linkType = "pulls";
              }
          
              const imageSrc = `https://img.shields.io/github/${linkType}/detail/state/${parts[1]}/${parts[2]}/${parts[4]}?label=&style=flat-square`;
              const image = document.createElement("img");
              image.setAttribute("src", imageSrc);
              image.classList.add("github-status-indicator");
          
              const info = onebox.querySelector(".github-info");
              if (info) {
                info.appendChild(image);
              }
            });
          },

david · September 21, 2023, 11:16pm

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

Topic		Replies	Views
Is there a nice GH badges (ala shields.io images) design to put in README to link from GitHub to our hosted discourse? feature docs-welcome	17	4782	September 13, 2019
Shields.io unable to retrieve Discourse statistics API support	12	774	December 6, 2023
Image lightbox not working in subfolder install installation subfolder	19	2244	October 12, 2021
Discourse/discourse-segment-io-plugin installation extras	1	997	May 3, 2021
Share Link Shortener theme-component official , share-link-shortener	23	2449	December 21, 2023

GitHub Status Indicators

Related Topics