Prevent cloud misconfigurations and find vulnerabilities during build-time in infrastructure as code, container images and open source packages with Checkov by Bridgecrew.
the plan file needs to be pretty printed in order to see the issue in the code block. If the plan file is in raw json then the code block doesn't appear. This isn't obvious in the documentation. I added a note.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
[//]: # "
Plan file JQ clarification
Be aware that we use the title to create changelog automatically and therefore only allow specific prefixes
- docs: to indicate an update to our documentation
Description
the plan file needs to be pretty printed in order to see the issue in the code block. If the plan file is in raw json then the code block doesn't appear. This isn't obvious in the documentation. I added a note.
If you have installed jq, you can convert a JSON file into multiple lines with the command terraform show -json tf.plan | jq '.' > tf.json, making it easier to read the scan result. NOTE: jq is required to show the code block as seen below.
[ x] My code follows the style guidelines of this project
[x ] I have performed a self-review of my own code
[x ] I have commented my code, particularly in hard-to-understand areas
[x ] I have made corresponding changes to the documentation
[x ] I have added tests that prove my feature, policy, or fix is effective and works
[ x] New and existing tests pass locally with my changes
[x ] Any dependent changes have been merged and published in downstream modules
Generated description
Dear maintainer, below is a concise technical summary of the changes proposed in this PR:
Add a note in the documentation to clarify the requirement of jq for pretty printing JSON plan files, ensuring the code block appears correctly.
<table><tr><th>Topic</th><th>Details</th><tr><td><a href=https://baz.co/changes/bridgecrewio/checkov/6447?tool=ast&topic=JQ+Requirement+Note>JQ Requirement Note</a>
</td><td>Clarify the requirement of <code>jq</code> for pretty printing JSON plan files in the documentation.<details><summary>Modified files (1)</summary><ul><li>docs/2.Basics/Installing Checkov.md</li></ul></details><details><summary>Latest Contributors(2)</summary><table><tr><th>Email</th><th>Commit</th><th>Date</th></tr><tr><td>28880387+tsmithv11@use...</td><td>docs-general-Switch-re...</td><td>November 08, 2023</td></tr>
anton.gruebel@gmail.com
docs-general-update-do...
July 18, 2023
This pull request is reviewed by Baz. Join @kyle9021 and the rest of your team on (Baz).
User description
the plan file needs to be pretty printed in order to see the issue in the code block. If the plan file is in raw json then the code block doesn't appear. This isn't obvious in the documentation. I added a note.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
[//]: # "
Plan file JQ clarification
Description
the plan file needs to be pretty printed in order to see the issue in the code block. If the plan file is in raw json then the code block doesn't appear. This isn't obvious in the documentation. I added a note.
If you have installed jq, you can convert a JSON file into multiple lines with the command
terraform show -json tf.plan | jq '.' > tf.json, making it easier to read the scan result. NOTE:jqis required to show the code block as seen below.Generated description
Dear maintainer, below is a concise technical summary of the changes proposed in this PR:
Add a note in the documentation to clarify the requirement of
jqfor pretty printing JSON plan files, ensuring the code block appears correctly.