Skip to content

Commit ef36c23

Browse files
Add instructions how to update plugin package snapshot (#924)
* Add info regarding package snapshot * Update CONTRIBUTING.md Co-authored-by: Serhii Snitsaruk <limbonaut@pm.me> * Update CONTRIBUTING.md --------- Co-authored-by: Serhii Snitsaruk <limbonaut@pm.me>
1 parent 294d7ce commit ef36c23

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,21 @@ In order to run automation tests navigate to `Settings -> Plugins -> Testing` an
4747
There is a demo level (`SentryDemo.umap`) in project's Content folder which presents a simple UI allowing to send some test events to Sentry. `W_SentryDemo` blueprint implementation shows how to call the plugin API and can be used as a reference.
4848

4949
In order to run the demo level navigate to `Content Browser -> Content -> Maps` and open `SentryDemo` map. Hit play to launch the demo.
50+
51+
## Modifying plugin content
52+
53+
All files that belong to the plugin are listed in the snapshot files:
54+
55+
- `/scripts/packaging/package-github.snapshot` (for the GitHub package)
56+
- `/scripts/packaging/package-marketplace.snapshot` (for the Marketplace package)
57+
58+
If you add, delete or move files within the `plugin-dev` directory these snapshot files must be updated to reflect the changes. To do that, run:
59+
60+
```bash
61+
pwsh ./scripts/packaging/pack.ps1
62+
pwsh ./scripts/packaging/test-contents.ps1 accept
63+
```
64+
65+
Once completed, make sure to commit the updated snapshot files to Git.
66+
67+
CI will run a separate check to compare the actual plugin package contents against the snapshot files.

0 commit comments

Comments
 (0)