...

Text file src/oss.terrastruct.com/d2/e2etests/README.md

Documentation: oss.terrastruct.com/d2/e2etests

     1# e2etests
     2
     3`e2etests` test the end-to-end flow of turning D2 scripts into a rendered diagram
     4
     5Tests fall under 1 of 3 categories:
     6
     71. **Stable**. Scripts which produce diagrams that never had issues this major release.
     82. **Regressions**. Scripts which used to have issues but no longer do. Each one should be
     9   linked to the PR which fixed it.
    103. **Todos**. Scripts which have an issue. If the issue prevents compile, `skip: true` can
    11   be set, otherwise the issue is visual. Each one should be linked to a Github Issue
    12   which describes it.
    13
    14Upon a major release, Regressions are carried over to Stable.
    15
    16If a change results in test diffs, you can run this script to generate a visual HTML
    17report with the old vs new renders.
    18
    19```
    20go run ./e2etests/report/main.go -delta
    21open ./e2etests/out/e2e_report.html
    22```

View as plain text