InvenTree
InvenTree copied to clipboard
[WIP] Docs screenshot automation
This PR introduces a proposed concept for "automating" the process of taking screenshots for the documentation.
While a certain amount of work to setup, it will ensure that we have a repeatable path to guarantee that the documentation screeenshots actually match the latest UI.
Utilizes the existing playwright workflow to create screenshots - with any level of complexity we require.
The screenshots are not generated on each PR, but with a single command can be generated:
npx playwright test --project screenshot
This proof of concept can be extended as we grow the interface - i.e. each new feature can be added into the product documentation as we iterate the user interface.
TODO
- [ ] Automate process of moving/copying generated screenshots into the documentation directory
- [ ] Update documentation to point to new auto-generated screenshots
Deploy Preview for inventree-web-pui-preview ready!
| Name | Link |
|---|---|
| Latest commit | 1e848b30bfbe787e6cb8b6b060b0b51980bdcc89 |
| Latest deploy log | https://app.netlify.com/sites/inventree-web-pui-preview/deploys/670f804367e3f0000844b58e |
| Deploy Preview | https://deploy-preview-7851--inventree-web-pui-preview.netlify.app |
| Preview on mobile | Toggle QR Code...Use your smartphone camera to open QR code link. |
Lighthouse |
1 paths audited Performance: 100 (no change from production) Accessibility: 86 (no change from production) Best Practices: 92 (no change from production) SEO: 70 (no change from production) PWA: - View the detailed breakdown and full score reports |
To edit notification comments on pull requests, go to your Netlify site configuration.
Codecov Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 83.66%. Comparing base (
7c19e51) to head (1e848b3). Report is 382 commits behind head on master.
Additional details and impacted files
@@ Coverage Diff @@
## master #7851 +/- ##
==========================================
- Coverage 84.35% 83.66% -0.69%
==========================================
Files 1164 1146 -18
Lines 52679 50200 -2479
Branches 1917 1917
==========================================
- Hits 44436 42002 -2434
+ Misses 7766 7710 -56
- Partials 477 488 +11
| Flag | Coverage Ξ | |
|---|---|---|
| pui | 67.26% <ΓΈ> (+0.32%) |
:arrow_up: |
Flags with carried forward coverage won't be shown. Click here to find out more.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
I'm going to close this out for now - an interesting idea that I might pick up again later. But for now, the extra work required for each screenshot does not justify this
