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

Add status badges for GHA's workflows #5620

Merged
merged 2 commits into from
Nov 8, 2022

Conversation

beni0888
Copy link
Collaborator

@beni0888 beni0888 commented Nov 8, 2022

Signed-off-by: Jesús Benito Calzada [email protected]

Description of the change

This PR adds several status badges to the README.md file for some of the GitHub Action's workflows (main, release and codeql).

Benefits

The latest status of the GitHub actions workflows is shown in the README.md file.

Possible drawbacks

N/A

Applicable issues

Additional information

N/A

Signed-off-by: Jesús Benito Calzada <[email protected]>
@beni0888 beni0888 self-assigned this Nov 8, 2022
@netlify
Copy link

netlify bot commented Nov 8, 2022

Deploy Preview for kubeapps-dev canceled.

Built without sensitive environment variables

Name Link
🔨 Latest commit 004f540
🔍 Latest deploy log https://app.netlify.com/sites/kubeapps-dev/deploys/636a84dd0bfd260008168583

@beni0888 beni0888 added component/ci Issue related to kubeapps ci system kind/enhancement An issue that reports an enhancement for an implemented feature github_actions Pull requests that update GitHub Actions code labels Nov 8, 2022
@beni0888 beni0888 added this to the Migrate CI to GitHub Actions milestone Nov 8, 2022
@beni0888 beni0888 marked this pull request as ready for review November 8, 2022 15:56
README.md Outdated
Comment on lines 5 to 6
[![Release Pipeline](https://github.com/vmware-tanzu/kubeapps/actions/workflows/kubeapps-release.yml/badge.svg)](https://github.com/vmware-tanzu/kubeapps/actions/workflows/kubeapps-release.yml)
[![CodeQL](https://github.com/vmware-tanzu/kubeapps/actions/workflows/codeql-scheduled.yml/badge.svg)](https://github.com/vmware-tanzu/kubeapps/actions/workflows/codeql-scheduled.yml)
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure we really need these two ones. I mean, given that the release is outsourced to Bitnami, does really make sense for us to show the status here?
Regarding the CodeQL, well... it's ok, but, what's really the point (for any user coming to the project, not for us, I mean)

Anyway, +1ing, we can always change it back :P

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Mmm... To be honest, I'm not sure either 😅 As I see it, CodeQL will reflect current compliance WRT the CodeQL analyzer, which could be interesting for people coming to the project and even for us, the maintainers, ourselves. And regarding the release workflow, even though the release is delegated to Bitnami, the release process is triggered by kubeapps and has an associated workflow... I think the key question here is, what is the target audience of these badges? Are they the maintainers/contributors, or the adopters? In case the answer is the latter, it probably doesn't make much sense to add those badges.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Besides that, we commented that would be interesting to add a new workflow in charge of running the Full Integration Workflow on schedule. Do you think it would be useful to add its badge to the README.md file?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@antgamdia Taking into account that we already have the Full Integration Pipeline and to run it on schedule we don't need to create a new workflow, but just add a new on.schedule event condition, I've added a badge for it and remove the one for the Release Pipeline because, as you pointed out, it maybe doesn't add much value. WDYT?

Copy link
Contributor

Choose a reason for hiding this comment

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

Ok, great! Makes sense. Let's keep all the badges for now, at least, it's great to see everything green :P

@beni0888 beni0888 merged commit 1774422 into vmware-tanzu:main Nov 8, 2022
@beni0888 beni0888 deleted the add-gha-status-badge branch November 8, 2022 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-not-required component/ci Issue related to kubeapps ci system github_actions Pull requests that update GitHub Actions code kind/enhancement An issue that reports an enhancement for an implemented feature
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants