Skip to content

docs: Make badges consistent, run markdownlint on all .md files#109

Merged
spetrosi merged 2 commits intomainfrom
update_role_files
Aug 24, 2023
Merged

docs: Make badges consistent, run markdownlint on all .md files#109
spetrosi merged 2 commits intomainfrom
update_role_files

Conversation

@spetrosi
Copy link
Copy Markdown
Contributor

  • 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 spetrosi@redhat.com

@spetrosi spetrosi requested review from Jakuje and richm as code owners August 23, 2023 11:03
- 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 <spetrosi@redhat.com>
Copy link
Copy Markdown
Collaborator

@Jakuje Jakuje left a comment

Choose a reason for hiding this comment

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

should we fix also the ansible lint issues or do you want to submit fix in separate PR?

![CI Testing](https://github.com/linux-system-roles/ssh/workflows/tox/badge.svg)
[![CI Ubuntu](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-ubuntu.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-ubuntu.yml)
[![CI Debian](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-debian.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-debian.yml)
[![ansible-debian.yml](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-debian.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-debian.yml) [![ansible-lint.yml](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-lint.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-lint.yml) [![ansible-test.yml](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-test.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-test.yml) [![ansible-ubuntu.yml](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-ubuntu.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/ansible-ubuntu.yml) [![shellcheck.yml](https://github.com/linux-system-roles/ssh/actions/workflows/shellcheck.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/shellcheck.yml) [![markdownlint.yml](https://github.com/linux-system-roles/ssh/actions/workflows/markdownlint.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/markdownlint.yml) [![woke.yml](https://github.com/linux-system-roles/ssh/actions/workflows/woke.yml/badge.svg)](https://github.com/linux-system-roles/ssh/actions/workflows/woke.yml)
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

whats the advantage of listing all the badges on a single line? Such long lines are hard to read/display in most of the editors and diffs are even harder to spot.

I initially placed them on separate lines as the Markdown merges them to a single line anyway and it is easier to track changes in them when they are on separate lines.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

The advantage is to generate them in .github, see https://github.com/linux-system-roles/.github/pull/42/files#diff-99e99bac7991cbf3337188c9f34cc45e998346d41ab9467aeea9406ad2654572R163
Doing this multi-line will be much harder. And given that there is automation, no need to maintain this line manually.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks for clarification! It was not sure to me on the first couple of reads through the changes here.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

It is nasty, yeah. There are spaces between badges to distinguish between them. Automation helps very much here.

Signed-off-by: Sergei Petrosian <spetrosi@redhat.com>
@spetrosi spetrosi merged commit c502a19 into main Aug 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants