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

feat: option to report details of unused snapshots #467

Merged
merged 6 commits into from
Mar 5, 2021

Conversation

eaculb
Copy link
Contributor

@eaculb eaculb commented Mar 5, 2021

Description

This PR introduces an additional CLI option that can be invoked to provide details (test name and snapshot location) of unused snapshots.

Related Issues

Checklist

  • This PR has sufficient documentation.
  • This PR has sufficient test coverage.
  • This PR title satisfies semantic convention.

Additional Comments

Not married to any wording or formatting; I tried to mirror what was already there as closely as possible.
I enjoy using syrupy in my projects! Thanks!

@eaculb
Copy link
Contributor Author

eaculb commented Mar 5, 2021

Hm ok, looks like the Windows VMs ends up with a different order for the unused snapshots? I'll adjust.

@noahnu
Copy link
Collaborator

noahnu commented Mar 5, 2021

This looks great!

I ran the coverage report locally and can confirm it's still reporting 100%. We can probably add a different step for contributors that posts the codecov to the PR directly w/o going through codecov to avoid the token issue.

@noahnu noahnu merged commit 1c50db0 into syrupy-project:master Mar 5, 2021
tophat-opensource-bot pushed a commit that referenced this pull request Mar 5, 2021
# [1.2.0](v1.1.0...v1.2.0) (2021-03-05)

### Features

* option to report details of unused snapshots ([#467](#467)), close [#465](#465) ([1c50db0](1c50db0))
@tophat-opensource-bot
Copy link
Contributor

🎉 This PR is included in version 1.2.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

@noahnu
Copy link
Collaborator

noahnu commented Mar 5, 2021

@all-contributors add eaculb for code, tests

@allcontributors
Copy link
Contributor

@noahnu

I've put up a pull request to add @eaculb! 🎉

@eaculb
Copy link
Contributor Author

eaculb commented Mar 5, 2021

Thank you & thanks for doing a release! :)

@eaculb eaculb deleted the unused-snapshot-reporting branch March 18, 2021 15:55
@eaculb
Copy link
Contributor Author

eaculb commented Mar 18, 2021

hi @noahnu ! I was just looking to upgrade my syrupy version within a project and noticed that 1.2.0 isn't available on pypi -- is this intentional or could the team please make it available? Thank you in advance!

@noahnu
Copy link
Collaborator

noahnu commented Mar 18, 2021

This isn't intentional. I'll take a look. We recently changed the publish process, there might be a regression.

@eaculb
Copy link
Contributor Author

eaculb commented Mar 18, 2021

thank you!

@noahnu
Copy link
Collaborator

noahnu commented Mar 18, 2021

@eaculb Sorry about that. Everything should be working now. Latest release is 1.2.2.

@eaculb
Copy link
Contributor Author

eaculb commented Mar 19, 2021

No problem -- Thanks so much for fixing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Report which snapshots are unused
3 participants