Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🔌 Plugin: codecov #218

Closed
2 tasks done
mlukasik-branch opened this issue Apr 28, 2023 · 6 comments
Closed
2 tasks done

🔌 Plugin: codecov #218

mlukasik-branch opened this issue Apr 28, 2023 · 6 comments

Comments

@mlukasik-branch
Copy link

🔖 Summary

Dedicated widget inside software catalog entity view showing actual code coverage pulled from codecov.io

🌐 Project website (if applicable)

https://app.codecov.io/

✌️ Context

Simplest solution I propose is to:

  1. pull latest average coverage from codecov API using URL

API request:

GET https://codecov.io/api/v2/{service}/{owner_username}/repos/{repo_name}/coverage/?interval=30d&start_date={today}

sample response:

{ "count": 1, "next": null, "previous": null, "results": [ { "timestamp": "2023-04-02T00:00:00Z", "min": 60.93796, "max": 60.93796, "avg": 60.93796 } ], "total_pages": 1 }

  1. On entity widget present following essential data: latest avg, timestamp, link to codecov dashboard (for details)

👀 Have you spent some time to check if this plugin request has been raised before?

  • I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

Are you willing to submit PR?

Yes I am willing to submit a PR!

@benjdlambert
Copy link
Member

Sure think this sounds good! Do you want to throw together a PR for something? 🙏 Think that this could be it's own frontend plugin that provides a Widget or a Card for integrators to use?

@mlukasik-branch
Copy link
Author

Happy to make it happen.

this week I want to release its first version inside my company, next week collect feedback and then decide how to release it to our dear open source community.

also want to clarify with my company if they are interested releasing it under their brand (still open source naturally).

@jadametz
Copy link

@mlukasik-branch Are you still working on this? This is something we'd love to take advantage of!

@mlukasik-branch
Copy link
Author

plugin has already been deployed and tested as part of my company internal backstage instance.

covered software catalog use caes by dedicated widget (gauge card)

  1. ability to see latest minimum code coverage value coimng from codecov.io on entity overview page

Screenshot 2023-09-26 at 7 10 48 PM

Screenshot 2023-09-26 at 7 10 53 PM

  1. ability to see meaningful message if coverage data cannot be found inside codecov.io

Screenshot 2023-09-26 at 7 12 20 PM

3 ability to display menaingful error message if something goes wrong during data fetching from codecov.io

I will try to release its code to community this week
for now without compatibility with newest backstage backend syste (released with backstage v1.18)

@freben
Copy link
Member

freben commented Apr 23, 2024

ping @mlukasik-branch :) moving this to the community plugins repo now which is a great home for contributions

@freben freben transferred this issue from backstage/backstage Apr 23, 2024
Copy link
Contributor

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the stale label Aug 31, 2024
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Sep 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants