docs: remove help note for tf-plan.json restriction [CC-793] #1834
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
ipapast
approved these changes
Apr 16, 2021
teodora-sandu
force-pushed
the
docs/tf-plan-help-note
branch
from
32a8fe6
to
8bb11ca
Compare
1 task
aron
reviewed
Apr 16, 2021
| @@ -61,6 +61,7 @@ function parseIacFileData(fileData: IacFileData): any[] { | |||
| let yamlDocuments; | |||
|
|
|||
| try { | |||
| // the YAML library can parse both YAML and JSON content | |||
There was a problem hiding this comment.
Nice! Two last points now I read this again.
- Worth adding here that the reason we use YAML is it means we don't have to disambiguate between, JSON, single YAML doc and multiple YAML doc as the parser does it for us?
- In the spirit of the names of the other functions and to be explicit perhaps this should be called
parseYAMLOrJSONFileData()to be clear that this will not support a terraform file for example.
There was a problem hiding this comment.
Is it a bit clearer now? I've tried to address both points, hopefully it makes sense 😃
This commit updates the snyk --help command to remove the note on the Terraform plan file name restriction [CC-793]
teodora-sandu
force-pushed
the
docs/tf-plan-help-note
branch
from
8bb11ca
to
0d729a4
Compare
aron
approved these changes
Apr 16, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do?
This PR updates the
snyk --helpcommand to remove the note about the Terraform plan file name restriction.Where should the reviewer start?
Have a look at the markdown document for any spelling mistakes.
How should this be manually tested?
Run
npm run generate-helpand have a look at the sections that changed.Any background context you want to provide?
The code changes were delivered under #1822.
What are the relevant tickets?
https://snyksec.atlassian.net/browse/CC-793
Screenshots