Migrating to axe DevTools HTML v4.x for Java
Steps for migrating to version 4.x of axe DevTools HTML for Java
axe DevTools HTML Maven v4.x is a major rewrite of the entire project. The most notable changes are summarized below, followed by more specific changes to relevant packages.
axe-devtools-* suite of java packages, involved re-architecting the product offering from both a rebranding perspective as well as to slim down the provided integration tools to be more specific to developer experience.
With this in mind, compared to previous versions where only a single package was provided, in this version a collection of packages are provided allowing for the end-user to pick and choose what is essential & fits best with the end-users current workflow.
Beware of breaking changes. Given the split from a monolithic package structure to an individual modular structure and the rebranding of API, migrating to v4.0 requires following this migration guide step by step.
There is no changes with the default environment requirements. The desired requirements are as below:
Ensure you have access to axe DevTools through one of the available options:
After successful, access setup, one may install any of the below packages, by including them in the
Example for the
selenium package installing from Deque's Agora:
<dependency> <groupId>com.deque.html.axe-devtools</groupId> <artifactId>selenium</artifactId> <version>4.x.x</version> </dependency>
The available packages are:
Please refer to each of the above packages, for usage instructions and detailed API documentation.
Asides installation and usage changes with the outlined packages, some noteworthy changes include:
- java package namespace changed from
Attestclass was renamed to
- The Environment variable for configuring custom rules has been changed from
- The default ruleset has changed. Axe DevTools audits a given page with
wcag2as the default ruleset. No change is required by the end-user. If one wished to configure a different ruleset, they may use the respective clauses offered in Cucumber/ RSpec.