This repository has been archived by the owner on Feb 2, 2023. It is now read-only.
v1.1.0 update #7
Merged
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.
Add an option to output the result of the normalize-yml script in the same format as the files it is expected to ingest. This allows the script to be used to collate multiple files into one authoratitve file.
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>
…al_format Add option to output normalized YAML in our software list schema
…vendors Output separate YAML files for cisagov conversion
Instead of creating a `reporter` key for every entry in the converted Markdown we instead establish data ownership at in the YAML file as a whole. This will ensure that all data in a given YAML file is attributed to a specific source as was intended by the `reporter` key.
This updates the normalize-yml and yml2md scripts to work with the addition of the owners key to the YAML format. This includes handling different owners per ingested file, multiple owners in an ingested file, and de-duplicating owner entries for output.
Update the docstring for the normalize_yml.munge function to reflect the functionality added related to the document top-level "owners" key. Co-authored-by: dav3r <david.redmin@trio.dhs.gov>
Remove the `reporter` key from the `software` example entry in the README and make sure the keys are correctly sorted.
Refactor the logic in the normalize-yml script to treat the "owners" key data consistently. This is a result of lgtm warning about modifying a parameter with a default value. Relying on Python's pass-by-reference is also a somewhat ugly way to approach handling that data in the first place.
Replace individual `reporter` keys with a document top-level `owners` key
mcdonnnj
added
the
improvement
Pull Request Test Coverage Report for Build 1679728331
💛 - Coveralls |
jsf9k
approved these changes
Jan 11, 2022
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 requests serves to merge the
v1.1.0release intodevelop. This release includes the following updates;reporterkeys with a document top-levelownerskey #6💭 Motivation and context
This will bring the
v1.1.0feature set into release for this project.🧪 Testing
Automates tests pass. I have done functionality testing in cisagov/github-actions-playground/testing/log4j_list_update.
✅ Pre-approval checklist
to reflect the changes in this PR.
✅ Pre-merge checklist
✅ Post-merge checklist