From 4b1186133d03be8bbfd1791120c2709d35e078c2 Mon Sep 17 00:00:00 2001 From: Sergei Petrosian <30409084+spetrosi@users.noreply.github.com> Date: Thu, 24 Aug 2023 08:27:58 +0200 Subject: [PATCH] docs: Make badges consistent, run markdownlint on all .md files (#143) - 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 --- .github/workflows/markdownlint.yml | 8 ++++++-- .github/workflows/woke.yml | 12 ++++++------ .gitlab-ci.yml | 2 +- README-ansible.md | 3 +-- README.md | 4 +++- contributing.md | 8 +++----- 6 files changed, 20 insertions(+), 17 deletions(-) diff --git a/.github/workflows/markdownlint.yml b/.github/workflows/markdownlint.yml index 98e3c4c3..2c1ef606 100644 --- a/.github/workflows/markdownlint.yml +++ b/.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 diff --git a/.github/workflows/woke.yml b/.github/workflows/woke.yml index f1476dc7..c8322e41 100644 --- a/.github/workflows/woke.yml +++ b/.github/workflows/woke.yml @@ -1,19 +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 diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 1091ccef..16379b06 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -145,7 +145,7 @@ markdownlint: stage: tier0 script: - chcon -R -t container_ro_file_t "../$(basename $(pwd))" - - podman run --rm --volume "$(pwd):/ha_cluster:ro" docker://avtodev/markdown-lint:master --config /ha_cluster/.markdownlint.yaml /ha_cluster/README.md # wokeignore:rule=master + - podman run --rm --volume "$(pwd):/ha_cluster:ro" docker://avtodev/markdown-lint:master --config /ha_cluster/.markdownlint.yaml --ignore /ha_cluster/CHANGELOG.md /ha_cluster/**/*.md # wokeignore:rule=master woke: extends: .job_generic_linter diff --git a/README-ansible.md b/README-ansible.md index bdd47b19..01a54eb9 100644 --- a/README-ansible.md +++ b/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), diff --git a/README.md b/README.md index 08709c45..d91a5622 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # ha_cluster -![CI Testing](https://github.com/linux-system-roles/ha_cluster/workflows/tox/badge.svg) +[![ansible-lint.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/ansible-lint.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/ansible-lint.yml) [![ansible-test.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/ansible-test.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/ansible-test.yml) [![codeql.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/codeql.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/codeql.yml) [![shellcheck.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/shellcheck.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/shellcheck.yml) [![markdownlint.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/markdownlint.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/markdownlint.yml) [![woke.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/woke.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/woke.yml) [![python-unit-test.yml](https://github.com/linux-system-roles/ha_cluster/actions/workflows/python-unit-test.yml/badge.svg)](https://github.com/linux-system-roles/ha_cluster/actions/workflows/python-unit-test.yml) + +--- An Ansible role for managing High Availability Clustering. diff --git a/contributing.md b/contributing.md index d43f8f76..da156649 100644 --- a/contributing.md +++ b/contributing.md @@ -1,8 +1,6 @@ -Contributing to the ha_cluster Linux System Role -================================================ +# Contributing to the ha_cluster 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/ha_cluster), 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**.