Tag Results
As part of the transition from the Axe DevTools Mobile dashboard to Axe Developer Hub, tags are now deprecated. If you have been using tags in your tests, they will still function as before. You will see a deprecation warning in the Appium server log the first time tags are used in a session. You may wish to start removing tags as a settings parameter.
Tagging is a helpful feature to organize, share, and search for scans within the Axe DevTools Mobile Dashboard. Some helpful tags for your team may be the team name, build number, simulator version, etc.
Tagged scans are visible on the dashboard to everyone within your organization, whereas scans without tags are visible only to the user that created them. Tags have no effect on local-only results.
Send a Scan with a Tag
Add the key tags in the settings object, with the value(s) of any tag you'd like to add. In the JavaScript example below, a scan will be pushed to the dashboard with two tags, "v0.0.1" and "iOS 17.4". Note: tags can be added to axeSettings with or without the scanName key.
const axeSettings = {
apiKey: '<DEQUE_APIKEY>',
projectId: '<DEQUE_PROJECT_ID>'
}
const scanSettings = {
scanName: '<YOUR_SCAN_NAME>',
tags: ['v0.0.1', 'iOS 17.4']
// scanName and tags are deprecated. These values only label dashboard uploads, and have no effect on local results.
}
...
await driver.execute('mobile: axeStartSession', axeSettings)
// authentication settings are passed in once to `axeStartSession`
...
const result = await driver.execute(
'mobile: axeScan',
scanSettings
// deprecated features are not available on the session level and are still passed to `axeScan`
)