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: Add markdownlint, test_html_build, and build_docs workflows #122

Merged
merged 1 commit into from
Aug 14, 2023

Conversation

spetrosi
Copy link
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 [email protected]

@spetrosi spetrosi force-pushed the update_role_files branch 4 times, most recently from e456a5e to bace5be Compare August 9, 2023 12:09
@spetrosi
Copy link
Contributor Author

spetrosi commented Aug 9, 2023

MD tables convert to HTML properly

@spetrosi spetrosi force-pushed the update_role_files branch 2 times, most recently from 689d492 to 0cc687d Compare August 10, 2023 13:06
@richm
Copy link
Contributor

richm commented Aug 10, 2023

@spetrosi why is there a CHANGELOG.md update with a new release?

- 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 <[email protected]>
@spetrosi
Copy link
Contributor Author

@spetrosi why is there a CHANGELOG.md update with a new release?

update_files.yml from .github didn't rebase to main when pushing this change, but picked up the changelog update from the last commit, not sure what's going on. I've fixed this PR.

@spetrosi spetrosi merged commit 394fd03 into main Aug 14, 2023
17 checks passed
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