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

Docs: Created GH Action workflow to generated pdfs of checklist from markdown files #191

Merged
merged 8 commits into from
Nov 7, 2024

Conversation

natalialuzuriaga
Copy link
Collaborator

@natalialuzuriaga natalialuzuriaga commented Oct 29, 2024

Docs: Created GH Action workflow to generate pdfs of outbound checklist from markdown files

Problem

Now that for each outbound checklist we support 2 file formats, there is an opportunity to automate the process of updating the checklists by creating a github action that generates a new pdf whenever a change has been made in the checklist markdown file.

Solution

Created a new GH Action workflow called checklistMarkdownToPDF.yml

  • Triggered when a PR has been opened or updated for tier*/checklist.md files
  • First job identifies which checklist.md tiers have been updated. Stores them in an array
  • Second job generates newly updated pdfs for those tiers

Result

When a change has been made in tier*/checklist.md, a pdf of the updated checklist will be generated.

Test Plan

Testing can be found here, check out the last 3 commits: #190

Signed-off-by: Natalia Luzuriaga <[email protected]>
@natalialuzuriaga natalialuzuriaga added documentation Improvements or additions to documentation enhancement New feature or request automation labels Oct 29, 2024
Copy link
Contributor

@decause-gov decause-gov left a comment

Choose a reason for hiding this comment

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

🔥 🔥 🔥

LGTM +1 🚢

IDEA: Let's document/pull down copies of the jobs/workflows somewhere so that we have local backups in case there are any issues upstream?

Copy link
Collaborator

@IsaacMilarky IsaacMilarky left a comment

Choose a reason for hiding this comment

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

One minor issue but otherwise LGTM!

.github/workflows/checklistMarkdownToPDF.yml Show resolved Hide resolved
@natalialuzuriaga natalialuzuriaga merged commit 6a8221c into dev Nov 7, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants