ci: Make badges consistent, run markdownlint all .md files #631
Conversation
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## main #631 +/- ##
=======================================
Coverage 43.28% 43.28%
=======================================
Files 13 13
Lines 3068 3068
Branches 394 394
=======================================
Hits 1328 1328
Misses 1740 1740
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
spetrosi
force-pushed
the
update_role_files
branch
8 times, most recently
from
22f36dc
to
7b339eb
Compare
| @@ -1,5 +1,5 @@ | |||
| # yamllint disable rule:line-length | |||
| name: Check for non-inclusive language | |||
| name: Woke | |||
There was a problem hiding this comment.
The previous name is more descriptive as a task name IMHO.
There was a problem hiding this comment.
The badge is generated with tha name, so I wanted to make the badge toe have woke in it. Although, woke is not a widely-know tool, so maybe better have something more descriptive like Detect non-inclusive language
There was a problem hiding this comment.
Is there some way to have a different names for the badge, and the github workflow? I guess that would be confusing if you saw a badge called woke but no corresponding github action though
There was a problem hiding this comment.
Is this possible to let the badge have a more descriptive name so that it can be consistent with github workflow ?
There was a problem hiding this comment.
I don't think it's possible to have a different name for the badge, GitHub generates it and doesn't provide much controll.
I see two options:
- Have the badge and the workflow named
Woke, which is pretty and after all easy to remember for linux-system-roles devs what woke does. We can have the name of the job to beDetect non-inclusive languagefor clarity. I think it's a compromis and I implemented it in this PR for now for illustration. - Have the badge and the workflow named
Detect non-inclusive language, the badge looks too descriptive in this case though.
There was a problem hiding this comment.
Right now, the workflow name in PR CI jobs is Woke / Detect non-inclusive language, and the badge name is Woke. I think that's good enough.
There was a problem hiding this comment.
Thanks for addressing this, I agree with the current change.
|
And the CI task |
spetrosi
force-pushed
the
update_role_files
branch
8 times, most recently
from
994d3bf
to
fa2f54a
Compare
spetrosi
force-pushed
the
update_role_files
branch
from
3be5513
to
17fd8e9
Compare
- Consistently generate badges for GH workflows in README RHELPLAN-146921 - Run markdownlint on all .md files - Add custom-woke-action if not used already - Rename woke action to Woke for a pretty badge Signed-off-by: Sergei Petrosian <[email protected]>
spetrosi
force-pushed
the
update_role_files
branch
from
17fd8e9
to
c2400e5
Compare
Signed-off-by: Sergei Petrosian <[email protected]>
Signed-off-by: Sergei Petrosian <[email protected]>
Signed-off-by: Sergei Petrosian [email protected]