docs: add more readme flair #1295

lengau · 2025-09-12T23:16:57Z

We were only using the minimum amount of flair.

Rendered: https://github.com/canonical/craft-parts/blob/work/more-flair/README.md

Have you followed the guidelines for contributing?
Have you signed the CLA?
Have you successfully run make lint && make test?
Have you added an entry to the changelog (docs/reference/changelog.rst)?

We were only using the minimum amount of flair. ![What do you think of a person who only does the bare minimum?](https://y.yarn.co/5d341f52-5344-4110-9067-6db74c0b06ee_text.gif) Signed-off-by: Alex Lowe <[email protected]>

README.md

Signed-off-by: Alex Lowe <[email protected]>

README.md

Signed-off-by: Alex Lowe <[email protected]>

medubelko

And in the proper spirit of the 90s, it's like I'm looking at the site footer on Geocities.

I'm going to be the devil's advocate, assuming we want this to become a pattern across our projects. It's not what I had in mind with the README model.

Do we need all of these? There are several that from what I can tell don't provide a variable status. They feel like TF2 hats.

I think there ought to be a rational order to these, at minimum. Something like license > builds > security checks > build checks.

There's no way that download count is an honest metric, right?

upils

I agree with @medubelko. It is shiny and fun but it is becoming a bit too much and might be counterproductive by making it hard to find the desired information.

Should we write a small policy with what badges should be / could be / should not be present? (and where they should be?)

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Make sure to clean the package cache layer when an underlying layer is cleaned.

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Some of these are also causing frequent lint CI failures

Signed-off-by: Alex Lowe <[email protected]>

Co-authored-by: JJ Coldiron <[email protected]>

Signed-off-by: Alex Lowe <[email protected]>

bepri · 2025-09-17T16:35:10Z

README.md

+[![GitHub License][license-badge]][license-link]
+[![PyPI - Version](https://img.shields.io/pypi/v/craft-parts)][pypi]
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/craft-parts)][pypi]
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/craft-parts)


While this isn't as readily available information, I'm not sure about how useful it actually is. Given that we just run make setup and go about our day, the exact Python versions in use aren't that important to surface.

Also, why is this one formatted differently from the rest (doesn't begin with [)?

bepri · 2025-09-17T16:36:08Z

README.md

-[![Codecov Status][codecov-badge]][codecov-status]
-[![Code Style][ruff-badge]][ruff-site]
+[![Canonical Starcraft][starcraft-badge]][canonical-link]
+[![GitHub License][license-badge]][license-link]


I can understand wanting to add this (being GPL is cool!), but this information can already be found in multiple other places, particularly on the sidebar of the repository.

I'm on the side of "let's delete it", but if others have a strong FOSS spirit and strongly want to keep it, I'm okay with that too.

bepri · 2025-09-17T16:36:22Z

README.md

-[![Code Style][ruff-badge]][ruff-site]
+[![Canonical Starcraft][starcraft-badge]][canonical-link]
+[![GitHub License][license-badge]][license-link]
+[![PyPI - Version](https://img.shields.io/pypi/v/craft-parts)][pypi]


I don't think this is helpful information, it's already on the sidebar.

bepri · 2025-09-17T16:36:26Z

README.md

+[![Canonical Starcraft][starcraft-badge]][canonical-link]
+[![GitHub License][license-badge]][license-link]
+[![PyPI - Version](https://img.shields.io/pypi/v/craft-parts)][pypi]
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/craft-parts)][pypi]


bepri · 2025-09-17T16:38:55Z

README.md

+[![PyPI - Version](https://img.shields.io/pypi/v/craft-parts)][pypi]
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/craft-parts)][pypi]
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/craft-parts)
+[![QA][qa-badge]][qa-link]


nit: I wish this said "Tests", but that would have to be fixed by renaming the workflow file.

bepri · 2025-09-17T16:39:28Z

README.md

+[![PyPI - Downloads](https://img.shields.io/pypi/dm/craft-parts)][pypi]
+![PyPI - Python Version](https://img.shields.io/pypi/pyversions/craft-parts)
+[![QA][qa-badge]][qa-link]
+[![TICS][tics-badge]][tics-link]


This is only useful to us, and we have our own ways of checking the TICS status. I don't care for this badge.

bepri · 2025-09-17T16:39:39Z

README.md

+[![QA][qa-badge]][qa-link]
+[![TICS][tics-badge]][tics-link]
+[![GitHub commits since latest release][commits-badge]][releases-link]
+[![GitHub Release Date][release-date-badge]][releases-link]


This is already on the sidebar next to the version

bepri · 2025-09-17T16:39:59Z

README.md

-[![Documentation Status][rtd-badge]][rtd-latest]
-[![Codecov Status][codecov-badge]][codecov-status]
-[![Code Style][ruff-badge]][ruff-site]
+[![Canonical Starcraft][starcraft-badge]][canonical-link]


I actually love this. Should we talk to design about somehow getting an even prettier badge?

docs: add more readme flair

1c9d21b

We were only using the minimum amount of flair. ![What do you think of a person who only does the bare minimum?](https://y.yarn.co/5d341f52-5344-4110-9067-6db74c0b06ee_text.gif) Signed-off-by: Alex Lowe <[email protected]>

lengau commented Sep 12, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

fix: typo

61a8b7f

Signed-off-by: Alex Lowe <[email protected]>

lengau commented Sep 12, 2025

View reviewed changes

README.md Outdated Show resolved Hide resolved

lengau added 6 commits September 12, 2025 19:18

fix: typo

a116557

Signed-off-by: Alex Lowe <[email protected]>

fix: more flair

fd7d549

fix: more flair!

9f0fd4f

chore: okay maybe slightly less flair

81287fe

fix: MOAR FLAIR

288bdc7

fix: linkier Canonical flair

db9b079

lengau marked this pull request as ready for review September 13, 2025 00:39

lengau requested a review from cmatsuoka as a code owner September 13, 2025 00:39

lengau requested review from a team, jahn-junior and medubelko and removed request for cmatsuoka September 13, 2025 00:39

lengau mentioned this pull request Sep 13, 2025

ci: run plugin integration tests in separate jobs #1275

Merged

4 tasks

medubelko reviewed Sep 13, 2025

View reviewed changes

fix: better name

d749908

lengau marked this pull request as draft September 13, 2025 01:35

docs: HAAAAAAATS

fd11d60

upils reviewed Sep 15, 2025

View reviewed changes

renovate bot and others added 8 commits September 17, 2025 12:29

build(deps): update dependency pyright to v1.1.405 (#1297)

45db982

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

fix: clean the package cache when underlying layers are cleaned (#1292)

0962a15

Make sure to clean the package cache layer when an underlying layer is cleaned.

build(deps): update bugfixes (#1296)

11f21df

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

docs(changelog): Release 2.23.0 (#1299)

ab4cbfd

ci: run plugin integration tests in separate jobs (#1275)

a7d2e64

test: run all plugin tests with partitions (#1286)

65cfcea

docs: rewrite some redirects

8b51c52

Some of these are also causing frequent lint CI failures

build: remove pyright from dev dependencies (#1298)

6da62c0

Signed-off-by: Alex Lowe <[email protected]>

lengau and others added 6 commits September 17, 2025 12:29

ci: run non-plugin tests on more platforms (#1279)

6e53c34

fix: indent multiline examples correctly (#1200)

a14f20d

Co-authored-by: JJ Coldiron <[email protected]>

chore: pr suggestions

77a8941

Merge branch 'main' into work/more-flair

fce0e90

Signed-off-by: Alex Lowe <[email protected]>

fix: better documentation header

e6bfeba

fix: worse documentation header

5064710

bepri reviewed Sep 17, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: add more readme flair #1295

docs: add more readme flair #1295

Uh oh!

lengau commented Sep 12, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

medubelko left a comment •

edited

Loading

Uh oh!

upils left a comment

Uh oh!

bepri Sep 17, 2025

Uh oh!

bepri Sep 17, 2025

Uh oh!

bepri Sep 17, 2025

Uh oh!

bepri Sep 17, 2025

Uh oh!

bepri Sep 17, 2025

Uh oh!

bepri Sep 17, 2025

Uh oh!

bepri Sep 17, 2025

Uh oh!

bepri Sep 17, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

docs: add more readme flair #1295

Are you sure you want to change the base?

docs: add more readme flair #1295

Uh oh!

Conversation

lengau commented Sep 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

We were only using the minimum amount of flair.

Uh oh!

Uh oh!

Uh oh!

medubelko left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

upils left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

lengau commented Sep 12, 2025 •

edited

Loading

medubelko left a comment •

edited

Loading