ci: Make badges consistent, run markdownlint all .md files #42
Conversation
spetrosi
commented
Aug 18, 2023
spetrosi
commented
- Consistently generate badges for GH workflows in roles RHELPLAN-146921
- Run markdownlint on all .md files
- Rename woke action to Woke for a pretty badge
playbooks/update_files.yml
Outdated
| firstmatch: true | ||
| line: "\n \ | ||
| {%- if 'python_roles' in group_names -%}\ | ||
|  \ |
There was a problem hiding this comment.
It would be cool if we could somehow associate each badge with an action so that we didn't have this hardcoded list here.
The journald role has all of the badges in the title line - see https://github.com/linux-system-roles/journald/blob/main/README.md
There was a problem hiding this comment.
Not sure what you meant under "associate each badge with an action", but I found a way to automatically generate these badges from existing workflow, excluding some of them that do not require a badge. And also added present_badges in roles' host_vars to define role-specific badges. Tested it with network in linux-system-roles/network#631 so far. Please take a look.
spetrosi
force-pushed
the
readme-badges
branch
from
9b7e6c3
to
e984c9b
Compare
- Consistently generate badges for GH workflows in roles RHELPLAN-146921 - Run markdownlint on all .md files - Rename woke action to Woke for a pretty badge
spetrosi
force-pushed
the
readme-badges
branch
from
e984c9b
to
f62c04f
Compare
* Only update the badges line with lineinfile * Use linux-system-roles/lsr-woke-action * For metrics, ignore vendor directory with markdownlint
| present_badges: | ||
| - "[](https://coveralls.io/github/linux-system-roles/network)" | ||
| - "[](https://github.com/ambv/black)" | ||
| - "[](https://lgtm.com/projects/g/linux-system-roles/network/context:python)" |
There was a problem hiding this comment.
ok - but note that lgtm.com is deprecated and will be removed at some point https://github.blog/2022-08-15-the-next-step-for-lgtm-com-github-code-scanning/
There was a problem hiding this comment.
I just used what's in the network role already. We can revisit it later.
| regex: \[\!.* | ||
| firstmatch: true | ||
| line: "{%-for file in find.files -%}\ | ||
| [![{{ file.path | basename }}]\ |
There was a problem hiding this comment.
This means the badge will have the filename instead of a "user friendly" name?
There was a problem hiding this comment.
Nope, GitHub renders this fine to the name of the workflow, and it's easier to get the filename than to read it's name from a file.
