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.

Sign up for GitHub

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

Jump to bottom

Add markdownlint, test_converting_readme, and build_docs workflows #41

Merged
merged 8 commits into from
Aug 14, 2023
Merged

Add markdownlint, test_converting_readme, and build_docs workflows #41

merged 8 commits into from
Aug 14, 2023

Conversation

spetrosi
Copy link
Contributor

@spetrosi spetrosi commented Aug 3, 2023 •
edited
Loading

  • 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
Add markdownlint, test_html_build, and build_docs workflows
a53d55f 
- markdownlint runs against README.md to avoid any issues with
  converting it to HTML
- test_html_build 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
Copy link
Contributor Author

spetrosi commented Aug 8, 2023

I was running it in linux-system-roles/mssql#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 ansible-community/ansible-test-gh-action#56 (comment) is to remove the troublesome file.

spetrosi
spetrosi commented Aug 8, 2023
View reviewed changes
playbooks/templates/.github/workflows/build_docs.yml

- name: Copy latest README.html to docs/index.html for GitHub pages
if: env.RELEASE_VERSION == 'latest'
run: cp ${{ env.RELEASE_VERSION }}/README.html docs/index.html
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still store the latest README.md into docs/index.html in the docs branch. index.html is supposed to be the home web page, which in our case is README.md.

@spetrosi
Copy link
Contributor Author

spetrosi commented Aug 9, 2023

I merged linux-system-roles/mssql#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
Copy link
Contributor

richm commented Aug 10, 2023

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

@spetrosi
Copy link
Contributor Author

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

@spetrosi spetrosi merged commit cec21e4 into linux-system-roles:main Aug 14, 2023
This was referenced Aug 15, 2023
Merged
Merged
@spetrosi spetrosi changed the title Add markdownlint, test_html_build, and build_docs workflows Add markdownlint, test_converting_readme, and build_docs workflows Aug 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@richm richm richm approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@spetrosi @richm