Add markdownlint, test_converting_readme, and build_docs workflows

linux-system-roles / .github

Common github actions for the linux-system-roles organization

MIT License

1 stars 8 forks source link

Add markdownlint, test_converting_readme, and build_docs workflows #41

Closed spetrosi closed 1 year ago

spetrosi commented 1 year ago

markdownlint runs against README.md to avoid any issues with converting it to HTML
test_converting_readme converts README.md > HTML and uploads this test artifact to ensure that conversion works fine
build_docs converts README.md > HTML and pushes the result to the docs branch to publish dosc to GitHub pages site.

spetrosi commented 1 year ago

I was running it in https://github.com/linux-system-roles/mssql/pull/224 and ansible-test didn't like the pandoc template. In RPM spec we remove dot files prior to converting to the collection format, so I think it's a good idea to remove dot files in ansible-test workflow too rather than ignoring the dotted .pandoc_template.html5. And btw ansible-test is not able to ignore files or checks, the suggestion in https://github.com/ansible-community/ansible-test-gh-action/issues/56#top is to remove the troublesome file.

spetrosi commented 1 year ago

I merged https://github.com/linux-system-roles/mssql/pull/224 that introduced this. After merging, the build_docs workflow converted to README.html and put it into docs directory on docs branch. Then I enabled GitHub pages, they published the content to the web, and I added a link to the repository description.

richm commented 1 year ago

do you need to make any more changes based on review comments from the role PRs?

spetrosi commented 1 year ago

No more changes so far, but I am not done with all roles yet. I am fixing README.md in-place in each PR.