Tips for mxGraph version bump

February 14, 2025 ยท View on GitHub

Minimal check list

  • check the mxGraph changelog to see what could impact the lib
  • review issues list, in particular in the BPMN Rendering Improvements milestone which could be impacted or fixed by the version bump
  • apply the version bump
  • review the overridden mxGraph code, generally, we extends the mxGraph objects, so search for the extends mxgraph.mx string
  • ensure we have enough visual tests to cover any regression or changes introduced
  • run the performance tests on all OS, ensure we don't see any performance regressions and save the results

Manual tests

In addition to e2e tests, it is safer to perform manual testing using BPMN diagrams from the bpmn-visualization-examples repository or miwg-test-suite.

The bpmn-visualization-examples repository provides usage examples that can be used for such tests:

  • diagram load and navigation
  • custom behavior and css styling

In the repository of bpmn-visualization, test pages are also available (some are not used by e2e tests).

Resources