Skip to content

ci: Add markdownlint, test_html_build, and build_docs workflows#108

Merged
spetrosi merged 1 commit intomainfrom
update_role_files
Aug 14, 2023
Merged

ci: Add markdownlint, test_html_build, and build_docs workflows#108
spetrosi merged 1 commit intomainfrom
update_role_files

Conversation

@spetrosi
Copy link
Copy Markdown
Contributor

@spetrosi spetrosi commented Aug 9, 2023

  • 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.
  • Fix markdown issues in README.md

Signed-off-by: Sergei Petrosian spetrosi@redhat.com

@spetrosi spetrosi requested review from Jakuje and richm as code owners August 9, 2023 08:05
@spetrosi spetrosi force-pushed the update_role_files branch from fef8e5d to 224dba0 Compare August 9, 2023 08:07
@spetrosi
Copy link
Copy Markdown
Contributor Author

spetrosi commented Aug 9, 2023

Markdownlint succeeded on README.md, I am modifying it to trigger .github/workflows/build_docs.yml after this PR is merged.

Copy link
Copy Markdown
Collaborator

@Jakuje Jakuje left a comment

Choose a reason for hiding this comment

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

lgtm

- 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.
- Fix markdown issues in README.md

Signed-off-by: Sergei Petrosian <spetrosi@redhat.com>
@spetrosi spetrosi merged commit 5b3c5a9 into main Aug 14, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants