CHANGELOG.md

Changelog

5.2.1

Dependency updates

• Bump @badeball/cypress-cucumber-preprocessor from 18.0.6 to 19.0.1

• Bump @cucumber/messages from 22.0.0 to 23.0.0

• Bump axios from 1.5.1 to 1.6.0

5.2.0

Notable changes

• Add test environment support (fixes #223)

5.1.1

Notable changes

• Add Jira and Xray pings during plugin initialization for configuration verification (#199)

• Prevent results upload from modifying test issues unnecessarily (fixes #209, #210)

• Prevent Cucumber results upload of untagged scenarios (#214)

Dependency updates

• Bump axios from 1.5.0 to 1.5.1

5.1.0

Notable changes

• Move cypress to the plugin's peer dependencies to impose supported Cypress version ranges

• Prevent existing test execution issue data (summaries, descriptions) from being overwritten unnecessarily (fixes #191)

Dependency updates

• Bump @badeball/cypress-cucumber-preprocessor from 18.0.5 to 18.0.6

• Bump @cucumber/gherkin from 26.2.0 to 27.0.0

5.0.0

Cypress version 13 was recently released and changed the module API, which this plugin heavily relies on to upload test results to Xray. A few core feature of the plugin had to be rewritten to adapt to these changes.

Note Previous versions of Cypress will still work just fine, the plugin is backwards compatible regarding Cypress versions.

The changes included a removal of the test function code, which previously was used to update the test steps in Xray. Because the step updates were furthermore quite problematic/lackluster anyways (#50, #164, #169), step updates have been removed from the plugin entirely.

Note Cucumber feature file synchronization was not affected by this change, which means that upload of feature files can still change Cucumber steps in Xray.

Breaking changes

• The plugin will now never alter existing Xray test steps of tests with test type Manual

  • Removed xray.steps.update option

  • Removed xray.steps.maxLengthAction option

• The xray.status options have been refactored a little bit for maintainability reasons:

  4.0.4	5.0.0
  xray: { statusPassed: "OK", statusFailed: "NO", statusPending: "TBD", statusSkipped: "OMIT", }	xray: { status: { passed: "OK", failed: "NO", pending: "TBD", skipped: "OMIT", } }

  Note Their environment variables have not changed.

• With Node V16 being past its end of life date, the plugin now requires Node V18 (LTS) to be installed

Dependency updates

• Bump @badeball/cypress-cucumber-preprocessor from 18.0.4 to 18.0.5

4.0.4

Notable changes

• Prevent manual test steps from being overwritten although xray.steps.update is false (fixes #164)

Dependency updates

• Bump axios from 1.4.0 to 1.5.0

4.0.3

Notable changes

• Prevent missing scenario tags from throwing errors (fixes #100)

4.0.2

Notable changes

• Reset issue labels after feature file import (fixes #100)

• Use dynamic @badeball/cypress-cucumber-preprocessor import (fixes #152)

Dependency updates

• Bump @badeball/cypress-cucumber-preprocessor from 18.0.2 to 18.0.4

4.0.1

Notable changes

• Fix cypress-xray-plugin/register export (fixes #133)

Dependency updates

• Bump @badeball/cypress-cucumber-preprocessor from 18.0.1 to 18.0.2

• Bump dedent from 1.2.0 to 1.5.0

4.0.0

This version heavily focused on features surrounding the upload of Cucumber results. Unfortunately, the Cucumber results upload deviates from the upload of "normal" Cypress results in terms of behaviour regarding nonexistent issues, issue reuse or Jira configuration in general. The reason for this are simply limitations in Xray's APIs.

Some of the plugin's core functionality has been rewritten entirely to keep things consistent for both upload behaviours. Because of this, some options had to be removed since they are either not needed anymore or are now built into the plugin's internal workflows.

Breaking changes

• The plugin will now never create new Jira issues. The only exception to this rule are test execution issues.

  • It now only uploads results of Cypress tests which include a corresponding Jira key and skips all other tests

  • It now only uploads results of Cucumber tests which include both:

    • Issue tags for background elements (see here)

    • Issue tags for all scenarios and scenario backgrounds (see here)

  • It now also skips feature file upload/synchronization of feature files for which the above does not apply

  Note If the plugin still creates test or precondition issues somehow, please file a bug, since it's simply not supposed to anymore.

• Jira client instantiation is now mandatory, meaning both Xray and Jira credentials must always be provided

• Option jira.url is now mandatory

• The plugin's functions must now be imported without adding /plugin at the end:

  3.3.3	4.0.0
  import { addXrayResultUpload, configureXrayPlugin, syncFeatureFile } from "cypress-xray-plugin/plugin";	import { addXrayResultUpload, configureXrayPlugin, syncFeatureFile } from "cypress-xray-plugin";

• The configuration function now expects the Cypress configuration as first parameter:

  async setupNodeEvents(on, config) {
    await configureXrayPlugin(
      config, // here
      {
        jira: {
          projectKey: "CYP",
          url: "https://example.atlassian.net"
        }
      }
    );
    // ...
  }

• When Cucumber is used, enabling the JSON report of the cypress-cucumber-preprocessor plugin is now mandatory, for example:

  // .cypress-cucumber-preprocessorrc.json
  {
    "json": {
      "enabled": true,
      "output": "cypress/cucumber-json/formatted-report.json"
    }
  }

• Removed plugin.overwriteIssueSummary option

• Removed xray.testType option

• Removed jira.createTestIssues option

Notable changes

• Restrict exported plugin members to those defined in index.ts

• Add plugin.logDirectory option

• Add jira.testExecutionIssueType option

• Add jira.testPlanIssueType option

• Feature file upload/synchronization now automatically resets the summary should the import change it

• Logging output has been beautified

Dependency updates

• Bump semver and @cucumber/cucumber

3.3.3 and before

For versions 3.3.3 and before, please check the GitHub releases page.