Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Andreas Turban <andreas.turban@net-baustelle.de>
  • Loading branch information
leonard84 and AndreasTu committed Feb 16, 2024
1 parent b613d5d commit 471bf72
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/extensions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -770,12 +770,13 @@ You can also extend from the `Snapshotter` class to provide your own convenience
Check `org.spockframework.specs.extension.SpockSnapshotter` in the spock codebase for an example.

==== Configuration

The snapshots are stored in the `rootPath` directory, which can be configured either in the <<spock-configuration-file,Spock Configuration File>>, or via the `spock.snapshots.rootPath` system property.
The `rootPath` directory is required and the `@Snapshot` extension will throw an exception if it is not configured when the extension is used.

Snapshots can be updated when setting the `spock.snapshots.updateSnapshots` system property to `true`, or via the config file.

You can configure the extension to store the actual value in case of a mismatch by setting the `spock.snapshots.writeActual` system property to `true`, or via the config file.
You can configure the extension to store the actual value in case of a mismatch by setting the `spock.snapshots.writeActual` system property to `true`, or via the config file.
If enabled the extension will store the result in a file next to the original one with an additional `.actual` extension.
The `.actual` file will automatically be deleted on the next successful run, as long as the feature is still enabled.
This option is useful, when the snapshot is too large or complex to analyze with the built-in reporting.
Expand Down

0 comments on commit 471bf72

Please sign in to comment.