Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: Remove badges from README.md prior to converting to HTML #124

Merged
merged 1 commit into from
Aug 28, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/build_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
5 changes: 4 additions & 1 deletion .github/workflows/test_converting_readme.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: >-
Expand Down
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# 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)

---
[![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) [![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) [![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) [![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.

Expand Down
Loading