pemtajo / badge-readme

Add badges in your Readme

Hi , I'm Pedro Matias

Connect with me

My Last badges

To see all the other badges are here

Stuff I worked on last week

From: 15 April 2024 - To: 22 April 2024

Python   56 mins         ████████████████████████▓   98.99 %
Other    0 secs          ▒░░░░░░░░░░░░░░░░░░░░░░░░   01.01 %

My GitHub Stats

Latest Blog Posts

• 4 Tips to use Watson Discovery
• Adding badges to your Github profile
• How to improve your Github profile by adding badges
• Good test vs. bad test, como identificar?
• Tokens JWT! o que são? o que comem? onde vivem?

Skills

badge-readme's Issues

If the badge title contains double quotes the badge is rendered incorrectly

Currently this is the situation in my readme. As you can see there are badly rendered badges

---

• I have noticed that the badly rendered badges are the badges that have double quote inside the title.

• While badges without double quotes render correctly (see the first image).

Images Broken Link

I am facing an issue where the images are broken in the MD file. Could you please take a look at https://github.com/aress31/aress31 and help me troubleshoot this?

Permissions section in .yml file needed

I created the specified update-badges.yml

name: Update badges

on:
  schedule:
    # Runs at 0am UTC every day
    - cron: "0 0 * * *"
jobs:
  update-readme:
    name: Update Readme with badges
    runs-on: ubuntu-latest
    steps:
      - name: Badges - Readme
        uses: pemtajo/badge-readme@main

But when I ran the workflow I was getting a failed action with the error message
github.GithubException.GithubException: 403 {"message": "Resource not accessible by integration", "documentation_url": "https://docs.github.com/rest/repos/contents#create-or-update-file-contents"}

It looked like it was an issue with the GITHUB_TOKEN so I added the contents: write permission in the .yml and the problem went away.

name: Update badges

on:
  schedule:
    # Runs at 2am UTC
    - cron: "0 2 * * *"
jobs:
  update-readme:
    name: Update Readme with badges
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - name: Badges - Readme
        uses: pemtajo/badge-readme@main

Option to define the badge size within the README

It would be great if you could add an option that defines the badge size in the README view.
Something similar to ...

Option	Default Value	Description	Required
BADGE_SIZE	110	Defines the badge dimension.	No

After a little fiddling with Credly's URL structure, I figured out that you can manipulate the URL. If I replace the string /110x110/ with /150x150/, I get the following result.

Which makes a significant difference depending on the README profile design.

Default Size 110x110	Overriden Size 150x150

Further facts, which I could determine. The value should not exceed 600px width or height. Since most badges were deposited in this dimension size.

SVG and Extra Blank

Just wondering if it could be possible to use svg version of certificate badges rather than png. As svg would be crisper and scalable from 0 to infinite without quality loss.

Also, I noticed an extra - unnecessary - line break (OCD alert), see:

<!--START_SECTION:badges-->

[![Offensive Security Web Expert (OSWE)](https://images.credly.com/size/96x96/images/c8c413ce-fce6-4b61-89e6-6a1b9f1e358a/AWAE-OSWE-badge.png)](http://www.credly.com/badges/654e5bc5-0fbe-4d17-ab44-93331a1fc365 "Offensive Security Web Expert (OSWE)")
[![Offensive Security Certified Professional (OSCP)](https://images.credly.com/size/96x96/images/e3c9ad3c-b142-45ae-bb2b-2f19ff2b742a/PWK-OSCP-badge.png)](http://www.credly.com/badges/1064ddf3-8305-4f17-bc79-72f1e9f86408 "Offensive Security Certified Professional (OSCP)")
<!--END_SECTION:badges-->