Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(secret): Fix default value of --security-checks in docs #2107

Merged
merged 2 commits into from
May 16, 2022

Conversation

thiago-gitlab
Copy link
Contributor

@thiago-gitlab thiago-gitlab commented May 12, 2022

Description

The default value for the --security-checks option is incorrect in the docs.

See #2104

Related issues

Related PRs

Remove this section if you don't have related PRs.

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
Copy link

CLAassistant commented May 12, 2022

CLA assistant check
All committers have signed the CLA.

@thiago-gitlab thiago-gitlab changed the title Fix default value of --security-checks in docs (docs)Fix default value of --security-checks in docs May 12, 2022
@thiago-gitlab thiago-gitlab changed the title (docs)Fix default value of --security-checks in docs docs:Fix default value of --security-checks in docs May 12, 2022
@thiago-gitlab thiago-gitlab changed the title docs:Fix default value of --security-checks in docs docs(secret): Fix default value of --security-checks in docs May 12, 2022
@severinkaelin
Copy link

@thiago-gitlab I just came across this issue as well and saw that you already created a PR, thank you!

However, I wonder if the content inside the first parenthesis (highlighted in yellow) lists all possible values. If this is the case, we should also add "secret" there.

What do you think? Please let me know if I misinterpret this documentation "schema".

image

https://github.com/aquasecurity/trivy/pull/2107/files#diff-1279601f598738914691ea862b83589cdb9111bc4be6ca51850f7f7b19bf70c1R25

@thiago-gitlab
Copy link
Contributor Author

Good catch, @severinkaelin. I've updated the PR. Thank you.

@knqyf263 knqyf263 merged commit 89893a7 into aquasecurity:main May 16, 2022
@knqyf263
Copy link
Collaborator

Thanks!

liamg pushed a commit that referenced this pull request Jun 7, 2022
* Fix default value of --security-checks in docs

* Add missing value to security-checks option
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documented default for --security-checks is incorrect
4 participants