Uploaded image for project: 'Jenkins Website'
  1. Jenkins Website
  2. WEBSITE-644

Serve GitHub badges from the plugin site

    Details

    • Type: Improvement
    • Status: To Do (View Workflow)
    • Priority: Minor
    • Resolution: Unresolved
    • Component/s: plugin-site
    • Labels:
      None
    • Similar Issues:

      Description

      There is a lot of plugins using badges which are being generated using shields.io and other services. Unfortunately these badges are pretty unstable, and sometimes you need to reopen the page several times to get them displayed.

      Instead of that, we could serve badges from plugins.jenkins.io API. 

      • Plugin Site badge (reference to the plugins.jenkins.io landing)
      • Changelog badge (GitHub releases)
      • Installation stats badge
      • ...

      All these badges can be cached with long refresh intervals so that the load on the site is not that high. Would need testing anyway

       

        Attachments

          Activity

          Hide
          oleg_nenashev Oleg Nenashev added a comment -

          CC Joseph Petersen Tim Jacomb who might be interested.

          We could also add a markdown/asciidoc generator for badges to save time for maintainers

           

          Show
          oleg_nenashev Oleg Nenashev added a comment - CC Joseph Petersen Tim Jacomb who might be interested. We could also add a markdown/asciidoc generator for badges to save time for maintainers  
          Hide
          zbynek Zbynek Konecny added a comment -

          >badges can be cached with long refresh intervals

          This sounds like the plan is to build a CDN. Some badge providers already have a CDN (shields.io uses cloudflare), so I'm not sure this pays off.

          Note that GitHub serves all external images using camo.github.com ( https://github.com/atmos/camo) , I'm wondering if skipping camo as the middle man on the plugin site would help – maybe we can try that first? Doing that has security implications, but if we would do it only for whitelisted badge providers it should be safe.

          Show
          zbynek Zbynek Konecny added a comment - >badges can be cached with long refresh intervals This sounds like the plan is to build a CDN. Some badge providers already have a CDN (shields.io uses cloudflare), so I'm not sure this pays off. Note that GitHub serves all external images using camo.github.com ( https://github.com/atmos/camo ) , I'm wondering if skipping camo as the middle man on the plugin site would help – maybe we can try that first? Doing that has security implications, but if we would do it only for whitelisted badge providers it should be safe.
          Hide
          oleg_nenashev Oleg Nenashev added a comment -

          No strong opinion here. The problem is that the shields.io badges are often broken when you navigate to the pages.

          Even with CloudFlare, something is wrong there. I tried setting a custom cache refresh period (4 hrs) using advanced badge settings, but it was still breaking for me

          Show
          oleg_nenashev Oleg Nenashev added a comment - No strong opinion here. The problem is that the shields.io badges are often broken when you navigate to the pages. Even with CloudFlare, something is wrong there. I tried setting a custom cache refresh period (4 hrs) using advanced badge settings, but it was still breaking for me

            People

            • Assignee:
              Unassigned
              Reporter:
              oleg_nenashev Oleg Nenashev
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated: