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(repo): Update trivy repo usage and example #5049

Merged
merged 1 commit into from
Aug 28, 2023

Conversation

fbufler
Copy link
Contributor

@fbufler fbufler commented Aug 27, 2023

Description

This PR adjusts the usage of the trivy repo command to mirror the changes regarding the support of "local repositories".
As this is my first PR, please tell me if I missed something!

Before

trivy repository --help

Scan a remote repository

Usage:
  trivy repository [flags] REPO_URL

Aliases:
  repository, repo

Examples:
  # Scan your remote git repository
  $ trivy repo https://github.com/knqyf263/trivy-ci-test
...

After

trivy repository --help

Scan a repository

Usage:
  trivy repository [flags] (REPO_PATH | REPO_URL)

Aliases:
  repository, repo

Examples:
  # Scan your remote git repository
  $ trivy repo https://github.com/knqyf263/trivy-ci-test
  # Scan your local git repository
  $ trivy repo /path/to/your/repository
...

Related issues

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. -> Just documentation changes
  • 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).

@fbufler fbufler requested a review from knqyf263 as a code owner August 27, 2023 09:27
@CLAassistant
Copy link

CLAassistant commented Aug 27, 2023

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link

CLA assistant check
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.

@fbufler fbufler changed the title Update trivy repo usage and example docs:(repo) Update trivy repo usage and example Aug 27, 2023
@fbufler fbufler changed the title docs:(repo) Update trivy repo usage and example docs:(repo): Update trivy repo usage and example Aug 27, 2023
@fbufler fbufler changed the title docs:(repo): Update trivy repo usage and example docs(repo): Update trivy repo usage and example Aug 27, 2023
Copy link
Collaborator

@knqyf263 knqyf263 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect. Thanks!

@knqyf263 knqyf263 added this pull request to the merge queue Aug 28, 2023
Merged via the queue into aquasecurity:main with commit 9345a98 Aug 28, 2023
15 of 17 checks passed
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.

doc: update trivy repo usage and example
3 participants