Skip to content

Added badges to the README.md file#686

Open
Evagan2018 wants to merge 1 commit intoOpen-CMSIS-Pack:mainfrom
Evagan2018:main
Open

Added badges to the README.md file#686
Evagan2018 wants to merge 1 commit intoOpen-CMSIS-Pack:mainfrom
Evagan2018:main

Conversation

@Evagan2018
Copy link

Fixes

Changes

-Added badges to the README.md file

Screenshots

Checklist

  • 🤖 This change is covered by unit tests (if applicable).
  • 🤹 Manual testing has been performed (if necessary).
  • 🛡️ Security impacts have been considered (if relevant).
  • [x ] 📖 Documentation updates are complete (if required).
  • 🧠 Third-party dependencies and TPIP updated (if required).

Copy link
Collaborator

@KeilChris KeilChris left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why do we have three license badges? The Apache 2.0 and GPL v3.0 and later should suffice.

Copy link
Collaborator

@jreineckearm jreineckearm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am about to head off into the weekend. I'll mark as "request changes" as I'd like to understand why we need this huge amount of badges.

image

Also, I added this in the past to the workflow to remove them before packaging the VSIX file for consumption in VS Code:

- name: Remove badges

These reflect the current state of the repo, which may be misinterpreted as the state of the VSIX that the user installed.

Let's discuss next week if these badges should show in the extension installation, too.

[![Dependency review](https://img.shields.io/github/actions/workflow/status/Open-CMSIS-Pack/vscode-cmsis-debugger/dependency-review.yml?logo=arm&logoColor=0091bd&label=Dependency%20review)](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/tree/main/.github/workflows/dependency-review.yml)
[![Publish static analysis](https://img.shields.io/github/actions/workflow/status/Open-CMSIS-Pack/vscode-cmsis-debugger/scorecard.yml?logo=arm&logoColor=0091bd&label=Publish%20static%20analysis)](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/tree/main/.github/workflows/scorecard.yml)
[![TPIP check](https://img.shields.io/github/actions/workflow/status/Open-CMSIS-Pack/vscode-cmsis-debugger/tpip.yml?logo=arm&logoColor=0091bd&label=TPIP%20check)](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/tree/main/.github/workflows/tpip.yml)
[![Build and release vsix](https://img.shields.io/github/actions/workflow/status/Open-CMSIS-Pack/vscode-cmsis-debugger/nightly.yml?logo=arm&logoColor=0091bd&label=Build%20and%20release%20vsix)](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/tree/main/.github/workflows/nightly.yml)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be called Nightly like the workflow.

[![License Apache-2.0](https://img.shields.io/github/license/Open-CMSIS-Pack/vscode-cmsis-debugger?label=LICENSE-Apache-2.0)](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/blob/main/LICENSE-Apache-2.0)
[![License Apache-2.0 AND GPL-3.0-or-later](https://img.shields.io/github/license/Open-CMSIS-Pack/vscode-cmsis-debugger?label=LICENSE-Apache-2.0%20and%20GPL-3.0-or-later)](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/blob/main/LICENSE)
[![License GPL-3.0-or-later](https://img.shields.io/github/license/Open-CMSIS-Pack/vscode-cmsis-debugger?label=LICENSE-GPL-3.0-or-later)](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/blob/main/LICENSE-GPL-3.0-or-later)
[![CI Test results](https://img.shields.io/github/actions/workflow/status/Open-CMSIS-Pack/vscode-cmsis-debugger/ci.yml?logo=arm&logoColor=0091bd&label=Test%20results)](https://github.com/Open-CMSIS-Pack/vscode-cmsis-debugger/tree/main/.github/workflows/ci.yml)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This workflow runs test results but is also used for publishing.
Is this reflecting the last run for a specific branch, or for the whole repo?

@jreineckearm
Copy link
Collaborator

jreineckearm commented Jan 14, 2026

Coming back to this...my suggestion is to only add the following badges:

UPDATE: We probably can live without the Arm logo for the new badges? No strong opinion though.

Let's see how cluttered the area is with that.

Update these workflow steps to remove newly added badges before VSIX packaging. The links aren't snapshots of a release but life data. And I don't see user value having them in a VSIX release:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants