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

docs: update CI status and included release badge #447

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

JP-sDEV
Copy link

@JP-sDEV JP-sDEV commented Oct 16, 2024

#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.

Copy link
Collaborator

@aciba90 aciba90 left a 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)

Copy link
Collaborator

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:

Suggested change

Copy link
Collaborator

@aciba90 aciba90 left a 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

@JP-sDEV
Copy link
Author

JP-sDEV commented Oct 17, 2024

Understood, I will only include the CI and Tag and Versioning workflows from the main branch. I will also put the badges on a single line (e.g. side by side)

Or did you want all the workflows badges in the main branch to be in the README?

@JP-sDEV
Copy link
Author

JP-sDEV commented Oct 21, 2024

Is the failed workflow a config error? or do I need to fix something on my end?

@aciba90
Copy link
Collaborator

aciba90 commented Oct 22, 2024

all the workflows badges in the main branch to be in the README

I think that is what makes sense, thanks!

Is the failed workflow a config error? or do I need to fix something on my end?

Yes, before merging you need to bump the version in https://github.com/canonical/pycloudlib/blob/main/VERSION.

@JP-sDEV
Copy link
Author

JP-sDEV commented Oct 22, 2024

Thanks @aciba90! I have updated the version. :)

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.

2 participants