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.

Sign up for GitHub

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: add workflow badges to the README #1066

Merged
merged 5 commits into from
Nov 16, 2023
Merged

docs: add workflow badges to the README #1066

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fc994ac
Add workflow badges.
tonyandrewmeyer Nov 16, 2023
cc994e8
Fix URLs.
tonyandrewmeyer Nov 16, 2023
fb0ec3f
Merge branch 'main' into badge-readme
tonyandrewmeyer Nov 16, 2023
56d0fa7
Adjust badges as per review.
tonyandrewmeyer Nov 16, 2023
dee9a98
publish uses 'yml', everything else uses 'yaml', go figure.
tonyandrewmeyer Nov 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# The `ops` library

![Charmcraft pack](https://github.com/canonical/operator/actions/workflows/charmcraft-pack.yaml/badge.svg)
![Compatibility: DB charms](https://github.com/canonical/operator/actions/workflows/db-charm-tests.yaml/badge.svg)
![Compatibility: Basic charms](https://github.com/canonical/operator/actions/workflows/hello-charm-tests.yaml/badge.svg)
![Compatibility: Observability charms](https://github.com/canonical/operator/actions/workflows/observability-charm-tests.yaml/badge.svg)
![CI Status](https://github.com/canonical/operator/actions/workflows/framework-tests.yaml/badge.svg)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Hmm, I'm wondering if we really need/want all of these. Maybe just the Charmcraft pack and CI Status ones?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't think they are super useful in the README itself. I'm not sure what the aim is with the releases page. @jnsgruk what workflows would you like to see showing up there?

Copy link
Member

Choose a reason for hiding this comment

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

I think probably just the ops test workflow and the publish workflow?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, changed!


The `ops` library is a Python framework for developing and testing Kubernetes and machine [charms](https://juju.is/docs/sdk/charmed-operators). While charms can be written in any language, `ops` defines the latest standard, and charmers are encouraged to use Python with `ops` for all charms. The library is an official component of the Charm SDK, itself a part of [the Juju universe](https://juju.is/).

Expand Down
Loading