docs: Make badges consistent, run markdownlint on all .md files (#123)

- 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
- Use woke from linux-system-roles/lsr-woke-action

Signed-off-by: Sergei Petrosian <[email protected]>

.github/workflows/markdownlint.yml

@@ -27,8 +27,12 @@ jobs:
       - name: Check out code
         uses: actions/checkout@v3
 
-      - name: Lint README.md
+      # CHANGELOG.md is generated automatically from PR titles and descriptions
+      # It might have issues but they are not critical
+      - name: Lint all markdown files except for CHANGELOG.md
         uses: docker://avtodev/markdown-lint:master
         with:
-          args: README.md
+          args: >-
+            --ignore=CHANGELOG.md
+            **/*.md
           config: .markdownlint.yaml

.github/workflows/woke.yml

@@ -1,18 +1,19 @@
 # yamllint disable rule:line-length
-name: Check for non-inclusive language
+name: Woke
 on:  # yamllint disable-line rule:truthy
   - pull_request
 jobs:
   woke:
-    name: woke
+    name: Detect non-inclusive language
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
         uses: actions/checkout@v3
 
-      - name: woke
-        uses: get-woke/woke-action@v0
+      - name: Run lsr-woke-action
+        # Originally, uses: get-woke/woke-action@v0
+        uses: linux-system-roles/lsr-woke-action@main
         with:
-          woke-args: "-c https://raw.githubusercontent.com/linux-system-roles/tox-lsr/main/src/tox_lsr/config_files/woke.yml"
+          woke-args: "-c https://raw.githubusercontent.com/linux-system-roles/tox-lsr/main/src/tox_lsr/config_files/woke.yml --count-only-error-for-failure"
           # Cause the check to fail on any broke rules
           fail-on-error: true

README-ansible.md

@@ -1,5 +1,4 @@
-Introduction to Ansible for Linux System Roles
-==============================================
+# Introduction to Ansible for Linux System Roles
 
 If you are not familiar with Ansible, please see
 [Introduction to Ansible for Linux System Roles](https://linux-system-roles.github.io/documentation/intro-to-ansible-for-system-roles.html),

README.md

@@ -1,5 +1,9 @@
 # VPN System Role
 
+[![ansible-lint.yml](https://github.com/linux-system-roles/vpn/actions/workflows/ansible-lint.yml/badge.svg)](https://github.com/linux-system-roles/vpn/actions/workflows/ansible-lint.yml) [![ansible-test.yml](https://github.com/linux-system-roles/vpn/actions/workflows/ansible-test.yml/badge.svg)](https://github.com/linux-system-roles/vpn/actions/workflows/ansible-test.yml) [![codeql.yml](https://github.com/linux-system-roles/vpn/actions/workflows/codeql.yml/badge.svg)](https://github.com/linux-system-roles/vpn/actions/workflows/codeql.yml) [![python-unit-test.yml](https://github.com/linux-system-roles/vpn/actions/workflows/python-unit-test.yml/badge.svg)](https://github.com/linux-system-roles/vpn/actions/workflows/python-unit-test.yml) [![shellcheck.yml](https://github.com/linux-system-roles/vpn/actions/workflows/shellcheck.yml/badge.svg)](https://github.com/linux-system-roles/vpn/actions/workflows/shellcheck.yml) [![markdownlint.yml](https://github.com/linux-system-roles/vpn/actions/workflows/markdownlint.yml/badge.svg)](https://github.com/linux-system-roles/vpn/actions/workflows/markdownlint.yml) [![woke.yml](https://github.com/linux-system-roles/vpn/actions/workflows/woke.yml/badge.svg)](https://github.com/linux-system-roles/vpn/actions/workflows/woke.yml)
+
+---
+
 A Role for managing setup and configuration of VPN tunnels.
 
 Basic usage:

contributing.md

@@ -1,8 +1,6 @@
-Contributing to the vpn Linux System Role
-=========================================
+# Contributing to the vpn Linux System Role
 
-Where to start
---------------
+## Where to start
 
 The first place to go is [Contribute](https://linux-system-roles.github.io/contribute.html).
 This has all of the common information that all role developers need:
@@ -22,7 +20,7 @@ are likely to be suitable for new contributors!
 **Code** is managed on [Github](https://github.com/linux-system-roles/vpn), using
 [Pull Requests](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests).
 
-### Python Code
+## Python Code
 
 The Python code needs to be **compatible with the Python versions supported by
 the role platform**.