Skip to content

Plugin⚓︎

The plugin offers several options for customizing the upload further.

Optional settings⚓︎

debug⚓︎

Turns on or off extensive debugging output.

Environment variable
PLUGIN_DEBUG
Type
boolean
Default
false
Example 
1
2
3
4
5
await configureXrayPlugin(on, config, {
    plugin: {
        debug: true
    },
});

1
npx cypress run --env PLUGIN_DEBUG=true

enabled⚓︎

Enables or disables the entire plugin. Setting this option to false disables all plugin functions, including authentication checks, uploads or feature file synchronization.

Environment variable
PLUGIN_ENABLED
Type
boolean
Default
true
Example 
1
2
3
4
5
await configureXrayPlugin(on, config, {
    plugin: {
        enabled: false
    },
});

1
npx cypress run --env PLUGIN_ENABLED=false

logDirectory⚓︎

The directory which all error and debug log files will be written to.

Environment variable
PLUGIN_LOG_DIRECTORY
Type
string
Default
"logs"
Example 
1
2
3
4
5
await configureXrayPlugin(on, config, {
    plugin: {
        logDirectory: "/home/logs"
    },
});

1
npx cypress run --env PLUGIN_LOG_DIRECTORY="/home/logs"

normalizeScreenshotNames⚓︎

Some Xray setups might struggle with uploaded evidence if the filenames contain non-ASCII characters. With this option enabled, the plugin only keeps characters a-zA-Z0-9. in screenshot names and replaces all other sequences with _.

Environment variable
PLUGIN_NORMALIZE_SCREENSHOT_NAMES
Type
boolean
Default
false
Example 
1
2
3
4
5
await configureXrayPlugin(on, config, {
    plugin: {
        normalizeScreenshotNames: true
    },
});

1
npx cypress run --env PLUGIN_NORMALIZE_SCREENSHOT_NAMES=true