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.

Sign up for GitHub

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

Jump to bottom

Add --no-fetch to all scan-local-repo examples #252

Merged
merged 1 commit into from
Nov 1, 2021
Merged

Add --no-fetch to all scan-local-repo examples #252

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/examplecleanup.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,7 @@ More on this later!)
mv tartufo.toml tartufo.toml_bak
mv tartufo.toml_new tartufo.toml
# one final run to make sure your signatures are all set
tartufo --regex scan-local-repo ${gitrepo}
tartufo --regex scan-local-repo --no-fetch ${gitrepo}

#. Once you are happy with the data that is being stored, time to commit the
changes back up!
Expand Down
8 changes: 4 additions & 4 deletions docs/source/features.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,14 +23,14 @@ Scanning a Local Repository

.. code-block:: sh

$ tartufo scan-local-repo /path/to/my/repo
$ tartufo scan-local-repo --no-fetch /path/to/my/repo

To use ``docker``, mount the local clone to the ``/git`` folder in the docker
image:

.. code-block:: sh

$ docker run --rm -v "/path/to/my/repo:/git" godaddy/tartufo scan-local-repo /git
$ docker run --rm -v "/path/to/my/repo:/git" godaddy/tartufo scan-local-repo --no-fetch /git

.. note::

Expand Down Expand Up @@ -95,7 +95,7 @@ Using Docker for Linux, that will look something like this:

$ docker run --rm -v "/path/to/my/repo:/git" \
-v $SSH_AUTH_SOCK:/agent -e SSH_AUTH_SOCK=/agent \
godaddy/tartufo scan-local-repo /git
godaddy/tartufo scan-local-repo --no-fetch /git


When using Docker Desktop for Mac, use ``/run/host-services/ssh-auth.sock`` as
Expand Down Expand Up @@ -414,7 +414,7 @@ in the config file:
> tartufo \
--include-path-patterns 'src/' -ip 'gradle/' \
--exclude-path-patterns '(.*/)?\.classpath$' -xp '.*\.jmx$' \
scan-local-repo file://path/to/my/repo.git
scan-local-repo --no-fetch file://path/to/my/repo.git


Additional usage information is provided when calling ``tartufo`` with the
Expand Down
4 changes: 2 additions & 2 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,15 @@ Getting started is easy!
$ tartufo scan-remote-repo git@github.com:my_user/my_repo.git

# Or, scan a local clone of a repo!
$ tartufo scan-local-repo /path/to/your/git/repo
$ tartufo scan-local-repo --no-fetch /path/to/your/git/repo

.. code-block:: console

# Scan a remote repo using docker
$ docker run --rm godaddy/tartufo scan-remote-repo https://github.com/my_user/my_repo.git

# Mount a local clone of a repo and scan it using docker!
$ docker run --rm -v "/path/to/your/git/repo:/git" godaddy/tartufo scan-local-repo /git
$ docker run --rm -v "/path/to/your/git/repo:/git" godaddy/tartufo scan-local-repo --no-fetch /git

For more detail on usage and options, see :doc:`usage` and :doc:`features`.

Expand Down