Skip to content

readme.md: update GitHub actions status badges#4854

Closed
alexandear wants to merge 1 commit intocppcheck-opensource:mainfrom
alexandear:patch-1
Closed

readme.md: update GitHub actions status badges#4854
alexandear wants to merge 1 commit intocppcheck-opensource:mainfrom
alexandear:patch-1

Conversation

@alexandear
Copy link
Copy Markdown
Contributor

@alexandear alexandear commented Mar 4, 2023

According to the doc a workflow status badge must have syntax:

https://github.com/danmar/cppcheck/actions/workflows/<WORKFLOW_FILE>/badge.svg

So, changed readme.md to the following:

GitHub Actions OSS-Fuzz Coverity Scan Build Status License
CI-cygwin
CI-mingw
CI-unixish-docker
CI-unixish
CI-windows
OSS-Fuzz Coverity Scan Build Status License

@firewave
Copy link
Copy Markdown
Collaborator

firewave commented Mar 4, 2023

Thanks for your contribution.

Looking at this I wonder if the "GitHub Actions" part still makes sense.
Development is mostly done via PRs and we only merge them if all builds pass. So even if a direct push to the main branch causes it to break that needs to be resolved immediately as it would break any PR. So those badges provide no useful information as they are virtually always green.

Having a badge for code coverage would be much better (not sure if we can get that out of codecov). And as it is something which we don't actively follow up on it would also be helpful.

I am trying to think any other badges to use but that would have to be some metric which comes from an external source. Any suggestions/thoughts?

@firewave
Copy link
Copy Markdown
Collaborator

firewave commented Mar 4, 2023

@danmar https://docs.codecov.com/docs/status-badges
I am not able to access the badge part of the settings.

Some notes on the coverage data:

  • we need to exclude the test sources as well as tinyxml2 and picojson from the coverage. simplecpp should stay as we are partially acting as the actual tests for it.
  • it seems like master is still configured as the default/primary branch but it should be main

@alexandear
Copy link
Copy Markdown
Contributor Author

Having a badge for code coverage would be much better

Agree.

Anyway, we should definitely fix the current not working badge "GitHub Actions Status":
image

@danmar
Copy link
Copy Markdown
Collaborator

danmar commented Mar 7, 2023

I am not able to access the badge part of the settings.

me neither directly. can we wait with that a little.

@alexandear
Copy link
Copy Markdown
Contributor Author

alexandear commented Mar 7, 2023

So, should I need to close this PR?

@danmar
Copy link
Copy Markdown
Collaborator

danmar commented Mar 8, 2023

I think you should remove the CI-cygwin](https://github.com/danmar/cppcheck/actions/workflows/CI-cygwin.yml/badge.svg etc

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