This repository has been archived by the owner on Feb 2, 2023. It is now read-only.
Output separate YAML files for cisagov conversion #4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Instead of printing one large YAML file to stdout we instead group the read software entires by the uppercased first character of the vendor name and output a file for each of these groups. All non-alphabet vendor entries are grouped in the "0-9" group manually. When testing the only entries that were non-alphabet were numeric. This will generate files that are small enough to be edited using the GitHub web UI.
mcdonnnj
added
the
improvement
Pull Request Test Coverage Report for Build 1660884981
💛 - Coveralls |
jsf9k
approved these changes
Jan 5, 2022
6 tasks
Use a more general (and accurate) key for the group of vendors that begin with a non-alphabetic character. Co-authored-by: Shane Frasier <jeremy.frasier@trio.dhs.gov> Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🗣 Description
This pull request changes the
convert-cisagovscript from printing the YAML for the convert Markdown tostdoutto instead output a series of files in a pre-defined format. These files contain entries grouped by the first character (in uppercase) of the product vendor.💭 Motivation and context
The resultant YAML file from converting the existing Markdown file is too large for the GitHub web UI to work with. There is an API limitation of 1MiB that a file needs to stay under for the web UI to allow in-browser editing/viewing. When the converted YAML is distributed across multiple files we can keep the individual file size to well below the 1MiB limit.
🧪 Testing
Automated tests pass. I confirmed that the processed Markdown is split up in the specified way when run locally.
✅ Pre-approval checklist