tmt icon indicating copy to clipboard operation
tmt copied to clipboard

Readme badges and pyproject cleanup

Open martinhoyer opened this issue 1 year ago • 7 comments

I'm not a friend with rst and have more experience with markdown. Will this render ok on PyPI page and other places? We also need to deal with man generation I presume? PyPA should be ok based on:

$ twine check dist/tmt-1.40.0.dev2+ga31e8651-py3-none-any.whl --strict
Checking dist/tmt-1.40.0.dev2+ga31e8651-py3-none-any.whl: PASSED

github would look like this: image

In pyproject, I've replaced Python 3.11 with 3.13 and removed the unmaintainable comments of what versions are available where.

Pull Request Checklist

  • [x] implement the feature

martinhoyer avatar Nov 25 '24 13:11 martinhoyer

image

Needs consensus on what badges are actually useful (which once to pick) and which of those make sense for them to be dynamic (versions, build successful).

I would say that Copr can be renamed to "Development/nighly builds" and just point to teemtee/latest, for example.

martinhoyer avatar Apr 10 '25 13:04 martinhoyer

image

Needs consensus on what badges are actually useful (which once to pick) and which of those make sense for them to be dynamic (versions, build successful).

I would say that Copr can be renamed to "Development/nighly builds" and just point to teemtee/latest, for example.

I'd probably drop "ruff" and "pre-commit", the rest will lead a user to some artifacts or docs, while these two are more like a statement, "yup, we test it", and we don't expect these to ever be red for main branch, correct?

happz avatar Apr 10 '25 13:04 happz

I'd probably drop "ruff" and "pre-commit", the rest will lead a user to some artifacts or docs, while these two are more like a statement, "yup, we test it", and we don't expect these to ever be red for main branch, correct?

Agreed, I feel it the same way.

psss avatar Apr 16 '25 13:04 psss

I'd probably drop "ruff" and "pre-commit", the rest will lead a user to some artifacts or docs, while these two are more like a statement, "yup, we test it", and we don't expect these to ever be red for main branch, correct?

Agreed, I feel it the same way.

@psss @happz I don't see what's wrong with that. It just tells people that this project uses pre-commit and ruff, which can increase the respect for the project, making them more likely to get involved. I mean, it's literally called a "badge".

Alas, removed as requested.

EDIT: oh and it can remind people to run pre-commit install. I tend to forget in new repos ;)

martinhoyer avatar Apr 23 '25 16:04 martinhoyer

The dependency version bumps shouldn't make any difference in theory, but just to be safe, added full_test label

martinhoyer avatar Apr 23 '25 20:04 martinhoyer

@martinhoyer LGTM, just a thought: do you think we can point the python-versions badge to a different place than pypi? IMHO some place in the docs would be better although I haven't found anything apart from a brief mention in the Unit Tests section

mcasquer avatar Apr 30 '25 06:04 mcasquer

Seems to be rendering well in both HTML docs and man page: neither of these two shows any sign of badges :/ Which I guess is fine, yet a bit surprising.

happz avatar Apr 30 '25 14:04 happz

Adding full test label - it seems trivial, but let's make sure RPMs built from the changed pyproject.toml don't hit any walls on distros beyond the core set of checks.

happz avatar May 19 '25 13:05 happz