Sharing the TOPS badge through GitHub

[jmbhughes]

I just completed the TOPS certification (link to certificate). Is there an easy way to share it on my GitHub profile? For now, I've downloaded the badge image and linked it to the certificate in my GitHub profile using HTML (see here). Sometimes badging services provide an easy markdown link to incorporate into GitHub profiles. Standard guidance and easy integration might help raise more visibility to this initiative.

Additionally, I work on the NASA PUNCH mission. We're very interested in making our work open. Some of our team members are looking into getting certified. How would you recommend we incorporate their badges into our code and data repositories?

[bressler95tops]

Thank you for this question @jmbhughes, this is actually a very good thing to ask. At this time, there isn't really a standardized way to embed a badge from Credly except for this method that uses Javascript and an iframe which GitHub does not support on markdown for projects and profiles for security reasons.

Although I should mention that it would work if you were to add it to a GitHub pages website.

Short of downloading the badge image and linking to your badge, another method that I can imagine is using custom GitHub badges. These are used by a variety of projects and apps and I don't see a reason to not use these on your profile.

With a bit of tinkering and trial and error with the parameters, I was able to put this on my own profile. You are welcome to have a look at my code and reuse it, the only thing you have to replace is the credly link in the markdown.

I do like the idea of streamlining this for researchers taking OS 101 and am open to other ideas.

[jmbhughes]

Thank you! Something like that badge will work. It'd be great to see researchers using it as they complete OS 101.

[bressler95tops]

Thank you! Something like that badge will work. It'd be great to see researchers using it as they complete OS 101.

Glad I could help!

[MathewBiddle]

Chiming in here as I was thinking this same thing! Once I finished the program I was looking for a markdown link on the credy site, similar to what zenodo provides for repository DOIs.

Anyways, I saw this GitHub Action on how to add credy badges to your GitHub profile https://github.com/pemtajo/badge-readme. I'm testing it out now and will report if it works.

[MathewBiddle]

It seemed to work. Here is the GitHub Action https://github.com/MathewBiddle/MathewBiddle/blob/main/.github/workflows/main.yml

Here is the commit the GitHub Action pushed MathewBiddle/MathewBiddle@357e61b

Here is the resultant readme https://github.com/MathewBiddle/MathewBiddle/blob/main/README.md

[4N0NYM0U5MY7H]

Nice! I like the idea of this option for my main profile and the more traditional badge for repositories.

[4N0NYM0U5MY7H]

If you receive a failed action error for this workflow, you may need to add the correct permissions.
See pemtajo/badge-readme#20 for a suggested fix.

[bressler95tops]

Interesting solution Mathew, I think this works really well. It's especially impressive in how it automates the addition of Credly badges if you are someone that has many of them. I also see that it essentially outputs the html embed version for each badge.