Skip to content
Projects

mikepenz/xray-action has 61 GitHub stars and 22 forks. GitHot measured 0 stars in 24 hours. Last checked 2026-11-15 22:19 UTC. Last push 2026-11-14.

How these counts are measured

Measured star growth

in 24h
0
in 7 days
Update delayed
in 15 days
Update delayed
in 1 month
Update delayed

Net star changes over overlapping periods, not daily totals. Missing measurements are left blank. Stars measure attention, not software quality.

About

... a GitHub action to import test results into "Xray" - A complete Test Management tool for Jira.

Productivity

README.md

Original

xray-action

... a GitHub action to import test results into Xray — the test management app for Jira.

CI Marketplace OpenSSF Scorecard License

xray-action: junit, cucumber, testng, xunit and robot reports funnel into a single Xray test execution issue

Quickstart 🛠️ • Inputs • Outputs • Reference 📖 • License 📓

🧾 9 report formats junit, xunit, nunit, testng, robot, cucumber, behave, xray, bundle
☁️ Cloud and Server/DC API key pairs for Xray Cloud, Jira credentials or a xrayToken PAT for Server/DC
🎯 Targets a test execution Reuse one via testExecKey, or let the action create it from projectKey
🔀 Merges split reports testMerge folds many junit / cucumber files into a single import
🛠️ Real Jira fields testExecutionJson / testJson set summary, issue type, components, custom fields
♻️ Survives flaky endpoints importRetryLimit, responseTimeout and importParallelism are all yours to tune

Quickstart 🛠️

1. Create a Xray API key — a pair of client id and client secret.

2. Store both as repository secrets, XRAY_CLIENT_ID and XRAY_CLIENT_SECRET.

3. Add the import step after your tests have run:

- name: "Import results to Xray"
  uses: mikepenz/xray-action@v4
  with:
    username: ${{ secrets.XRAY_CLIENT_ID }}
    password: ${{ secrets.XRAY_CLIENT_SECRET }}
    testFormat: "junit"
    testPaths: "**/test/*.xml"
    testExecKey: "TEST-1"
    projectKey: "TEST"

The results show up on TEST-1, and the action reports back how many files it imported via the count output.

[!TIP] On Xray Server/DC set xrayCloud: "false" and point xrayBaseUrl at your Jira instance — see Configure the workflow.


Reference

Topic
Configure the workflow Every input, for Xray Cloud and Server/DC
Test execution json Set Jira fields on the created test execution
Action outputs count, completed, failed, testExecKey, …
Contribute Build and test the action locally
Xray Which parts of the Xray REST API are covered

Setup

Configure the workflow

Specify the action as part of your GitHub actions workflow, using a Xray API key (i.e. a pair of client id and client secret):

Xray Cloud

- name: "Import results to Xray"
  uses: mikepenz/xray-action@{latest-release}
  with:
    username: ${{ secrets.XRAY_CLIENT_ID }}
    password: ${{ secrets.XRAY_CLIENT_SECRET }}
    testFormat: "junit"
    testPaths: "**/test/*.xml"
    testExecKey: "TEST-1"
    projectKey: "TEST"

Xray Server/DC

If you're using Xray Server/DC, you'll need to set xrayCloud as "false", use Jira credentials for authentication, and specify additional parameters.

- name: "Import results to Xray"
 uses: mikepenz/xray-action@{latest-release}
 with:
   username: ${{ secrets.JIRA_USERNAME }}
   password: ${{ secrets.JIRA_PASSWORD }}
   xrayCloud: "false"
   xrayBaseUrl: "https://myjiraserver.example.com"
   testFormat: "junit"
   testPaths: "**/test/*.xml"
   testExecKey: "TEST-1"
   projectKey: "TEST"
   importRetryLimit: "5"  # Retry up to 5 times on failure
   responseTimeout: "120000"  # 2 minutes timeout

⚠️ Xray Server/DC requires test plan, test env, revision to be defined via their custom field. See additional details on passing a custom test execution json.

💡 Do not specify username and password in cleartext, instead prefer to read them from GitHub action secrets.

Input Description Required
xrayCloud Defines which variant of Xray to target [cloud vs Server/DC] (default="true")
xrayBaseUrl Defines the base URL for Xray Server/DC, could be used to change XRay Data region for XRay Cloud (required if xrayCloud="false") x*
username Xray API client id (cloud) or Jira username (Server/DC). (Required for xrayCloud) x*
password Xray API client secret (cloud) or Jira password (Server/DC). (Required for xrayCloud) x*
xrayToken Xray Personal Access Token. If provided username/password are ignored. (Xray Server/DC only)
testFormat Describes the import formats ["xray", "cucumber", "behave", "junit", "testng", "nunit", "xunit", "robot", "bundle"] x
testPaths Glob expression to report paths. The default is **/junit-reports/TEST-*.xml. x
testMerge Merges together multiple test report files into a single report. Supported for: ["junit", "cucumber"]. (Default: true)
testExecKey Key of the Test Execution x
projectKey Key of the project where the Test Execution (if the testExecKey parameter wasn't provided) and the tests (if they aren't created yet) are going to be created. x
testPlanKey Key of the Test Plan; if you specify the Test Plan, the Tests will be added automatically to the Test Plan if they're not part of it.
testEnvironments A string containing a list of test environments separated by ";"
revision Source code and documentation version used in the test execution.
fixVersion The Fix Version associated with the test execution (it supports only one value).
combineInSingleTestExec If no testExecKey is provided, it will generate a testExec with the first import, and reuse the same for all other imports. (Default: false)
failOnImportError Defines if the action should fail if an import error occurred. (Default: false)
continueOnImportError Defines if the action should continue after a single import error occurred. (Default: true)
importParallelism Specifies the level of parallelism to import to Xray. (Default: 2)
responseTimeout Specifies the maximum duration for a request (in milliseconds) to wait for a response to execute before timing out. The default is 60000 milliseconds.
importRetryLimit Specifies the maximum number of retries for failed import requests. The default is 2.
testExecutionJson File path to a json file, containing the meta information to create the xray test execution ticket.
testJson File path to a json file, containing the meta information to create the xray test ticket.

Test execution json

The test execution json should the meta information in the following format:

Xray Cloud

{
    "fields": {
        "summary": "Brand new Test execution",
        "issuetype": { "id": "10007" },
        "components": [
            { "name": "Interface" },
            { "name": "Core" }
        ]
    }
}

Xray Server/DC

⚠️ For Xray Server/DC environments test plan, test env, revision fields are required to be provided via their custom field. See the official API documentation for more details.

{
    "fields": {
        "summary": "Brand new Test execution",
        "issuetype": { "id": "10007" },
        "components" : [
            { "name":"Interface" },
            { "name":"Core" }
        ],
        "customfield_10032" : [
            "TES-38"
        ]
    }
}

💡 The import will fail if the provided issueType for example does not exist. Please ensure correct information is provided.

Action outputs

After action execution it will return helpful information.

# ${{steps.{XRAY_STEP_ID}.outputs.count}}
${{steps.xray.outputs.count}}

A full set list of possible output values for this action.

Output Description
count The count of imported files.
completed The count of completed imports.
failed The count of failed imports.
errorMessage The message of failed imports.
errorStatusCode The status code of failed imports.
testExecKey The key of the created test execution.

Contribute 🧬

# Install the dependencies  
$ npm install

# Build the typescript and package it for distribution
$ npm run build && npm run package

# Run the tests, use to debug, and test it out
# Please note you have to uncomment the test
# Provide your xray instance username and password
# And then execute the test:
$ npm test

# Verify lint is happy
$ npm run lint -- --fix

Xray

Developed By

Other actions

License

Copyright 2025 Mike Penz

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.