Skip to content

OpenToonz - An open-source full-featured 2D animation creation software

C
2.6 KB
Raw Blame

Testing Pull Requests (PRs)

When a PR is submitted, it is compiled automatically by AppVeyor CI. The AppVeyor build creates an artifact which contains the OpenToonz executable and supporting DLLs needed to run. You can easily download this artifact and run it to test out the PR before it is merged.

Pre-Testing Notes

  • You need to have OpenToonz already installed. Do not uninstall.
  • It is recommended that you backup your C:\OpenToonz stuff folder before testing a PR.
  • The AppVeyor build does not contain an updated C:\OpenToonz stuff folder so any PR changes to default configurations (i.e. stylesheets, FXs, brushes, etc) are not automatically included.
  • It is recommended when testing to use new scenes that you can throw away.
    • If you decide to test on an existing scene, back it up first!

Downloading and Testing AppVeyor Builds

  • Go to the PR you are interested in checking out.

  • Scroll to the bottom of the page and look for the green-outlined box with All checks have passed in it. Click on it to expend.

  • Look for where it says AppVeyor build succeeded and click on the ... next to it, select View Details.

  • Click on Configuration: Release.

  • On the right side of the page, click on Artifacts.

  • Click on the OpenToonz .zip file to begin the download.

Downloading and Testing Github Action Builds

  • Similar to the previous steps, but start clicking different lines from step 3.

  • On the Details page, click Summary on the left side.

  • Scroll down to find the Download button.


  • Once download is complete, go to your Downloads folder and extract the contents of the .zip file anywhere on your computer.
  • You should extract into a separate folder.
  • ⚠️ Do not overwrite your current OpenToonz installation!
  • Enter the folder you extracted everything into and double-click the OpenToonz executable to start.
  • Test away! Report any suggestions or issues related to the change in the PR comments.
  • You can safely delete the .zip file and the folder you created when you are done.

Testing translation changes

Follow the translation guide to check which configuration directory the test executable loads. Verify the changed loc/<UI language name>/<module>.qm is present and current; an executable-only update does not establish this. Select the language, restart, and inspect the changed UI. Report the language, commit/build, catalog path, and observed wording.