docs(cli): update help string for file and dir skipping #4872

wyardley · 2023-07-27T05:34:05Z

Description

Update the contextual help messages
Add some additional examples (and clarify YAML file configuration) for globbing
Update docs
Fix broken link in skipping docs

Happy to adjust the wording or make other tweaks as necessary, but to me, this seems at least a little bit clearer

Related issues

skip file / directory patterns or globs #3754

Related PRs

Add pattern support for the skip-files and skip-dirs flags. #3843
feat(flag): Add glob support to --skip-dirs and --skip-files #3866
docs(cli): Improve glob documentation #3945
(all merged; just related / previous PRs related to this)

Before:

After:

Checklist

I've read the guidelines for contributing to this repository.
I've followed the conventions in the PR title.
I've added tests that prove my fix is effective or that my feature works.
I've updated the documentation with the relevant information (if needed).
I've added usage information (if the PR introduces new options)
I've included a "before" and "after" example to the description (if the PR is a user interface change).

CLAassistant · 2023-07-27T05:34:10Z

All committers have signed the CLA.

CLAassistant · 2023-07-27T05:34:10Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

AnaisUrlichs · 2023-07-27T07:49:47Z

docs/docs/configuration/skipping.md

@@ -11,12 +11,19 @@ This section details ways to specify the files and directories that Trivy should
 |     License      |     ✓     |

 By default, Trivy traverses directories and searches for all necessary files for scanning.
-You can skip files that you don't maintain using the `--skip-files` flag.
+You can skip files that you don't maintain using the `--skip-files` flag, or the equivalent YAML config option.


can we say "or using the equivalent Trivy YAML configuration." instead?
To make it clear that we don't mean Kubernetes YAML or similar

AnaisUrlichs · 2023-07-27T07:50:25Z

docs/docs/configuration/skipping.md

@@ -34,12 +47,19 @@ Will skip any file named `bar` in the subdirectories of testdata.
 |     License      |     ✓     |

 By default, Trivy traverses directories and searches for all necessary files for scanning.
-You can skip directories that you don't maintain using the `--skip-dirs` flag.
+You can skip directories that you don't maintain using the `--skip-dirs` flag, or the equivalent YAML config option.


Same here: can we say "or using the equivalent Trivy YAML configuration." instead?

AnaisUrlichs · 2023-07-27T07:52:30Z

docs/docs/configuration/skipping.md


-```
+```bash


Can we add a little subtitle *not bold or anything but just:

Using the --skip-dirs flag:

EXAMPLE

Using the Trivy YAML configuration:

EXAMPLE

AnaisUrlichs · 2023-07-27T07:53:01Z

docs/docs/configuration/skipping.md

@@ -48,12 +68,19 @@ $ trivy image --skip-dirs "./testdata/*" .

 Will skip all subdirectories of the testdata directory.


"This will skip.."

This was following the existing examples, but yes, can definitely update

AnaisUrlichs · 2023-07-27T07:53:18Z

docs/docs/configuration/skipping.md

+$ trivy config --skip-dirs "**/.terraform" .
+```
+
+Will skip subdirectories at any depth named `.terraform/`. (Note: this will match `./foo/.terraform` or


"This will skip" ...

AnaisUrlichs

added a few minor comments, thank you for the work

- Update the contextual help messages - Add some additional examples (and clarify YAML file configuration) for globbing - Update docs - Fix broken link in skipping docs See also #3754 Signed-off-by: William Yardley <wyardley@users.noreply.github.com>

wyardley · 2023-07-31T21:52:47Z

Hi @AnaisUrlichs - does that look good now?

knqyf263 · 2023-08-02T10:56:48Z

docs/docs/configuration/skipping.md

@@ -82,4 +113,4 @@ A file pattern contains the analyzer it is used for, and the pattern itself, joi
 --file-patterns "dockerfile:.*.docker" --file-patterns "kubernetes:*.tpl" --file-patterns "pip:requirements-.*\.txt"
 ```

-The prefixes are listed [here](https://github.com/aquasecurity/trivy/tree/{{ git.commit }}/pkg/fanal/analyzer/const.go)
+The prefixes are listed [here](../../../pkg/fanal/analyzer/const.go)


It will be deployed via MkDocs, so it doesn't work. I've reverted.
https://aquasecurity.github.io/trivy/v0.44/docs/configuration/skipping/

The issue I was trying to fix is that the current docs have a broken link when viewed via https://github.com/aquasecurity/trivy/blob/main/docs/docs/configuration/skipping.md (which gets linked to from various places IIRC)

…#4872) * docs(cli): update help string for file and dir skipping - Update the contextual help messages - Add some additional examples (and clarify YAML file configuration) for globbing - Update docs - Fix broken link in skipping docs See also aquasecurity#3754 Signed-off-by: William Yardley <wyardley@users.noreply.github.com> * docs: revert --------- Signed-off-by: William Yardley <wyardley@users.noreply.github.com> Co-authored-by: knqyf263 <knqyf263@gmail.com>

wyardley requested review from knqyf263, AnaisUrlichs and itaysk as code owners July 27, 2023 05:34

AnaisUrlichs reviewed Jul 27, 2023

View reviewed changes

knqyf263 requested a review from AnaisUrlichs August 1, 2023 09:52

docs: revert

923010b

knqyf263 reviewed Aug 2, 2023

View reviewed changes

knqyf263 approved these changes Aug 2, 2023

View reviewed changes

knqyf263 added this pull request to the merge queue Aug 2, 2023

Merged via the queue into aquasecurity:main with commit 6d3ae3b Aug 2, 2023

wyardley deleted the wyardley/docs/skipconf branch August 2, 2023 14:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs(cli): update help string for file and dir skipping #4872

docs(cli): update help string for file and dir skipping #4872

wyardley commented Jul 27, 2023 •

edited

Loading

CLAassistant commented Jul 27, 2023 •

edited

Loading

CLAassistant commented Jul 27, 2023

AnaisUrlichs Jul 27, 2023

AnaisUrlichs Jul 27, 2023

AnaisUrlichs Jul 27, 2023

AnaisUrlichs Jul 27, 2023

wyardley Jul 27, 2023

AnaisUrlichs Jul 27, 2023

AnaisUrlichs left a comment

wyardley commented Jul 31, 2023

knqyf263 Aug 2, 2023

wyardley Aug 2, 2023

		@@ -48,12 +68,19 @@ $ trivy image --skip-dirs "./testdata/*" .

		Will skip all subdirectories of the testdata directory.


		```
		```bash

docs(cli): update help string for file and dir skipping #4872

docs(cli): update help string for file and dir skipping #4872

Conversation

wyardley commented Jul 27, 2023 • edited Loading

Description

Related issues

Related PRs

Checklist

CLAassistant commented Jul 27, 2023 • edited Loading

CLAassistant commented Jul 27, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AnaisUrlichs left a comment

Choose a reason for hiding this comment

wyardley commented Jul 31, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wyardley commented Jul 27, 2023 •

edited

Loading

CLAassistant commented Jul 27, 2023 •

edited

Loading