-
Notifications
You must be signed in to change notification settings - Fork 30
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
docs: update CI status and included release badge #447
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks!
@@ -1,6 +1,8 @@ | |||
# pycloudlib | |||
|
|||
[![Build Status](https://travis-ci.com/canonical/pycloudlib.svg?branch=master)](https://travis-ci.com/canonical/pycloudlib) | |||
[![Pycloudlib CI](https://github.com/canonical/pycloudlib/actions/workflows/ci.yaml/badge.svg)](https://github.com/canonical/pycloudlib/actions/workflows/ci.yaml) | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: To display both badges on the same line:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wait, I think we should limit the badge status to jobs execute from the main
branch. Otherwise, failures from PRs will show up on the badges. See: https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/monitoring-workflows/adding-a-workflow-status-badge#using-the-branch-parameter
Understood, I will only include the CI and Tag and Versioning workflows from the Or did you want all the workflows badges in the |
Is the failed workflow a config error? or do I need to fix something on my end? |
I think that is what makes sense, thanks!
Yes, before merging you need to bump the version in https://github.com/canonical/pycloudlib/blob/main/VERSION. |
Thanks @aciba90! I have updated the version. :) |
#445 Updated CI status badge
Replaced the Travis CI badge with Github CI badge. Also included a badge for the status of the
Tag and Publish Release
workflow.