From 44e59831858830f3d305c8f85af18319b205ddeb Mon Sep 17 00:00:00 2001 From: Sergei Petrosian <30409084+spetrosi@users.noreply.github.com> Date: Mon, 28 Aug 2023 12:16:58 +0200 Subject: [PATCH] ci: Remove badges from README.md prior to converting to HTML (#633) - Remove thematic break after badges - Remove badges from README.md prior to converting to HTML Signed-off-by: Sergei Petrosian --- .github/workflows/build_docs.yml | 3 +++ .github/workflows/markdownlint.yml | 2 +- .github/workflows/test_converting_readme.yml | 5 ++++- README.md | 2 -- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml index 13efaab..78218ba 100644 --- a/.github/workflows/build_docs.yml +++ b/.github/workflows/build_docs.yml @@ -75,6 +75,9 @@ jobs: - name: Ensure that version and docs directories exist run: mkdir -p ${{ env.RELEASE_VERSION }} docs + - name: Remove badges from README.md prior to converting to HTML + run: sed -i '1,8 {/^\[\!.*actions\/workflows/d}' ref_branch/README.md + - name: Convert README.md to HTML and save to the version directory uses: docker://pandoc/core:latest with: diff --git a/.github/workflows/markdownlint.yml b/.github/workflows/markdownlint.yml index 757dec9..2c1ef60 100644 --- a/.github/workflows/markdownlint.yml +++ b/.github/workflows/markdownlint.yml @@ -34,5 +34,5 @@ jobs: with: args: >- --ignore=CHANGELOG.md - **/*.md + **/*.md config: .markdownlint.yaml diff --git a/.github/workflows/test_converting_readme.yml b/.github/workflows/test_converting_readme.yml index e545613..e93c501 100644 --- a/.github/workflows/test_converting_readme.yml +++ b/.github/workflows/test_converting_readme.yml @@ -28,7 +28,10 @@ jobs: - name: Check out code uses: actions/checkout@v3 - - name: Convert README.md to HTML and save to the version directory + - name: Remove badges from README.md prior to converting to HTML + run: sed -i '1,8 {/^\[\!.*actions\/workflows/d}' README.md + + - name: Convert README.md to HTML uses: docker://pandoc/core:latest with: args: >- diff --git a/README.md b/README.md index eb31cc2..a10f8c9 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,6 @@ [![ansible-lint.yml](https://github.com/linux-system-roles/network/actions/workflows/ansible-lint.yml/badge.svg)](https://github.com/linux-system-roles/network/actions/workflows/ansible-lint.yml) [![ansible-test.yml](https://github.com/linux-system-roles/network/actions/workflows/ansible-test.yml/badge.svg)](https://github.com/linux-system-roles/network/actions/workflows/ansible-test.yml) [![codeql.yml](https://github.com/linux-system-roles/network/actions/workflows/codeql.yml/badge.svg)](https://github.com/linux-system-roles/network/actions/workflows/codeql.yml) [![integration.yml](https://github.com/linux-system-roles/network/actions/workflows/integration.yml/badge.svg)](https://github.com/linux-system-roles/network/actions/workflows/integration.yml) [![python-unit-test.yml](https://github.com/linux-system-roles/network/actions/workflows/python-unit-test.yml/badge.svg)](https://github.com/linux-system-roles/network/actions/workflows/python-unit-test.yml) [![shellcheck.yml](https://github.com/linux-system-roles/network/actions/workflows/shellcheck.yml/badge.svg)](https://github.com/linux-system-roles/network/actions/workflows/shellcheck.yml) [![woke.yml](https://github.com/linux-system-roles/network/actions/workflows/woke.yml/badge.svg)](https://github.com/linux-system-roles/network/actions/workflows/woke.yml) [![markdownlint.yml](https://github.com/linux-system-roles/network/actions/workflows/markdownlint.yml/badge.svg)](https://github.com/linux-system-roles/network/actions/workflows/markdownlint.yml) [![Coverage Status](https://coveralls.io/repos/github/linux-system-roles/network/badge.svg)](https://coveralls.io/github/linux-system-roles/network) [![Code Style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/linux-system-roles/network.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/linux-system-roles/network/context:python) ---- - ## Overview The `network` role enables users to configure network on the target machines.