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

Convert baseline markdown files to text and HTML #1435

Merged

Conversation

james-garriss
Copy link
Collaborator

@james-garriss james-garriss commented Nov 20, 2024

🗣 Description

This PR converts the existing baseline files that are in Markdown to both HTML and text format. It saves them to the baselines folder and then makes that folder available as an artifact.

💭 Motivation and context

Closes: #1376

🧪 Testing

Wrote and tested original workflow in an alternate repository.
Once workflow was working, moved to SG repo and modified accordingly.
Verified expected results were found in the artifact.

image

✅ Pre-approval checklist

  • This PR has an informative and human-readable title.
  • PR targets the correct parent branch (e.g., main or release-name) for merge.
  • Changes are limited to a single goal - eschew scope creep!
  • Changes are sized such that they do not touch excessive number of files.
  • These code changes follow the ScubaGear [content style guide]
  • Related issues these changes resolve are linked preferably via [closing keywords]
  • All relevant type-of-change labels added.
  • All relevant project fields are set.
  • All automated checks (e.g., linting, static analysis, unit/smoke tests) passed.

✅ Pre-merge checklist

  • PR passed smoke test check.
  • Feature branch has been rebased against changes from parent branch, as needed
  • Resolved all merge conflicts on branch
  • Notified merge coordinator that PR is ready for merge via comment mention

✅ Post-merge checklist

  • Feature branch deleted after merge to clean up repository.
  • Verified that all checks pass on parent branch (e.g., main or release-name) after merge.

@james-garriss james-garriss added the enhancement This issue or pull request will add new or improve existing functionality label Nov 20, 2024
@james-garriss james-garriss added this to the Kraken milestone Nov 20, 2024
@james-garriss james-garriss self-assigned this Nov 20, 2024
@james-garriss james-garriss removed the request for review from adhilto November 20, 2024 15:09
Copy link
Collaborator

@buidav buidav left a comment

Choose a reason for hiding this comment

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

Looks good.
Wish there was a way to for loop this somehow but doing that in this workflow would be adding unnecessary abstraction.
Since, we don't change the baseline document names/locations often.

@james-garriss
Copy link
Collaborator Author

I don't disagree with the idea of a loop, @buidav , but given that we don't really understand what Drupal needs at this point, I was reluctant to spend more time on this task. I will put this on my personal backlog. If/when we get clarification, I will look at moving this into code (.ps1 function), where we can use a loop and add unit testing.

Copy link
Collaborator

@mitchelbaker-cisa mitchelbaker-cisa left a comment

Choose a reason for hiding this comment

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

Verified html/text files from output and looks good.

@james-garriss james-garriss force-pushed the 1376-convert-baseline-markdown-to-text-and-html branch from b3fcfd3 to f8d3fbc Compare December 4, 2024 17:13
@james-garriss
Copy link
Collaborator Author

@nanda-katikaneni

@nanda-katikaneni nanda-katikaneni merged commit 3ce71e9 into main Dec 4, 2024
27 checks passed
@nanda-katikaneni nanda-katikaneni deleted the 1376-convert-baseline-markdown-to-text-and-html branch December 4, 2024 20:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This issue or pull request will add new or improve existing functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Convert baseline Markdown files to Drupal
4 participants