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

add github workflow to generate html and pdf artifacts #231

Merged
merged 1 commit into from
May 3, 2023

Conversation

ahouseholder
Copy link
Contributor

resolves #184

This PR includes the following changes:

  • a github workflow that will produce an HTML and PDF artifact on each push to main or develop branches that affects any file in the doc directory or the workflow file itself.
  • adds a Makefile that replaces previous shell scripts for manually generating HTML and PDF locally (converting these scripts to a Makefile helped with figuring out the structure of the github workflow)
    • sample output from the Makefile can be found in ssvc_v2-0.html and ssvc_v2-0.pdf
  • Updates some of the "how-to" files in the doc directory to markdown format

Note that the github workflow uploads its artifacts to the workflow summary page rather than modifying the repository directly.

This PR is a squashed version of my current develop branch, so if you want to see a sample of the output of the workflow you can check out https://github.com/ahouseholder/SSVC/actions/runs/4834190249

@ahouseholder ahouseholder added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 28, 2023
@ahouseholder ahouseholder added this to the SSVC v2.1 milestone Apr 28, 2023
Copy link
Contributor

@sei-vsarvepalli sei-vsarvepalli left a comment

Choose a reason for hiding this comment

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

Wow - Good work @ahouseholder. I will follow-up with Dryad (ssvc-calc folder) updates to do the same and publish these here instead of democert.org using GitHub Pages.

@ahouseholder ahouseholder merged commit 08eacbe into CERTCC:main May 3, 2023
@ahouseholder ahouseholder self-assigned this May 23, 2023
@ahouseholder ahouseholder deleted the feature/fix_184 branch July 10, 2023 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Automate PDF generation with github actions
2 participants