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

updating docs to run current version of tartufo #71

Merged
merged 10 commits into from
Sep 15, 2020
Merged

updating docs to run current version of tartufo #71

merged 10 commits into from
Sep 15, 2020

Conversation

sjacoby-godaddy
Copy link
Contributor

No description provided.

@codecov
Copy link

codecov bot commented Sep 10, 2020

Codecov Report

Merging #71 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #71   +/-   ##
=======================================
  Coverage   94.03%   94.03%           
=======================================
  Files           6        6           
  Lines         436      436           
  Branches       86       86           
=======================================
  Hits          410      410           
  Misses         18       18           
  Partials        8        8           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ba09216...e0ec4a5. Read the comment docs.

Copy link
Contributor

@tarkatronic tarkatronic left a comment

Choose a reason for hiding this comment

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

Overall, I like the updates to the doc. I think it's becoming much more useful. Just a few changes, mostly around the talk of poetry. 👍

docs/source/examplecleanup.rst Outdated Show resolved Hide resolved
docs/source/examplecleanup.rst Show resolved Hide resolved
docs/source/examplecleanup.rst Outdated Show resolved Hide resolved
docs/source/examplecleanup.rst Outdated Show resolved Hide resolved
docs/source/examplecleanup.rst Outdated Show resolved Hide resolved
docs/source/examplecleanup.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@tarkatronic tarkatronic left a comment

Choose a reason for hiding this comment

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

Looking much better. Just a few more fixes and it'll be great!

docs/source/examplecleanup.rst Outdated Show resolved Hide resolved
docs/source/examplecleanup.rst Outdated Show resolved Hide resolved
docs/source/examplecleanup.rst Outdated Show resolved Hide resolved
docs/source/examplecleanup.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@tarkatronic tarkatronic left a comment

Choose a reason for hiding this comment

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

Just a few more things. I really want to be sure we get the docs "right" to be as helpful and educational as possible to our users. Apologies if I'm being a bit pedantic here.

Also, I would encourage testing all these doc changes locally with tox -e docs and then opening up docs/build/html/index.html, to make sure things are looking right.

docs/source/examplecleanup.rst Outdated Show resolved Hide resolved
docs/source/examplecleanup.rst Show resolved Hide resolved
docs/source/examplecleanup.rst Outdated Show resolved Hide resolved
docs/source/examplecleanup.rst Outdated Show resolved Hide resolved
mv pyproject.toml pyproject.toml_bak
mv pyproject.toml_new pyproject.toml
# one final run to make sure your signatures are all set
poetry run tartufo ${gitrepo} --regex --no-cleanup
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this underscores the need for a new command like tartufo creation-exclusion-list once #78 is done and merged. 😄

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yeah, that would be pretty sweet!

docs/source/examplecleanup.rst Outdated Show resolved Hide resolved
@tarkatronic tarkatronic merged commit 645806a into godaddy:master Sep 15, 2020
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.

2 participants