Skip to content

Latest commit

 

History

History
87 lines (75 loc) · 3.34 KB

migrating.md

File metadata and controls

87 lines (75 loc) · 3.34 KB
Raw

Migrating

This file documents breaking changes and how to handle them while using the main branch of typst-test. The entries are ordered in descending relevance, i.e. last breaking change first.

This file will be removed on the first release, as from then on, a changelog shall be curated.

CI semi stable tag pre-deprecation notice

The ci-semi-stable tag has received it's last bump to a pre-rewrite commit. It will soon be deprecated on the release of 0.1.0 of typst-test. The repository will likely be archived in ffavor of a new name.

Rewrite

The rewrite is now complete and the following things have changed and will be gradually tested, refined and stabilized until 0.1.0 is released:

  • edit exists but has no implementation anymore it will soon serve to edit tests's meta data like their reference kind instead of opening the tests
  • run, compare and update now take multiple tests and exact names for filtering, more elabirate filtering is done using -e ... with test set expressions
  • there are various
  • the output of list and status has changed
  • util has been added for running utility and debugging commands
  • various global options were moved to be on the respective commands they are relevant for only
  • typst test now brings it's own typst compiler (currently 0.11.1) and has no ability to change to another compiler version at the moment
  • reference images are no longer optimized when written to, this may be added back before 0.1.0

Many of the aforementioned features are only tested locally and need further testing before the rewrite is fully done.

CI semi stable tag

The ci-semi-stable tag will no longer be bumped on breaking changes. Instead a branch of the same name that follows main is provided for the same purpose.

Simply change your CI step to use the branch option instead:

 jobs:
   tests:
     # ...
     steps:
       - name: Install typst-test from github
         uses: baptiste0928/[email protected]
         with:
           crate: typst-test
           git: https://github.com/tingerrr/typst-test.git
-          tag: ci-semi-stable
+          branch: ci-semi-stable
     # ...

Folder Structure

The folder structure changed from having all tests in a dediacted folder with references and the like in different dedicated folders to having a dedicated folder per test. To use your existing project's tests, the scripts have to be moved and renamed. Previously tests were be arranged like follows:

tests/
  typ/
    test1.typ
    test2/
      test.typ
      ...
    ...

To reuse the scripts, move them into the following structure:

tests/
  test1/
    test.typ
    ref/
      1.png
    out/
      ...
    diff/
      ...
  test2/
    test.typ
    ...
  ...

Furthermore, the patterns in the test/.gitignore should be adjusted from out/** to **/out/, the same for diff.

Observe the following:

  • free standing tests are no longer allowed, they must be in a folder and be named test.typ
  • tests can now be nested, their path serves as their name
  • references, output and diff images now live directly next to the test script in their respective sub folders

You can copy the references into the sub folders, or simply regenerate them using the update sub command.

If you used relative paths they must be adjusted, if you used absolute paths, then the tests should continue to work as expected.