mikepenz/xray-actionPublic

generated fromactions/typescript-action

NotificationsYou must be signed in to change notification settings
Fork21
Star58

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

License

Apache-2.0 license

58 stars 21 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Use this GitHub action with your project

Add this Action to an existing workflow or create a new one

View on Marketplace

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 891 Commits
.devcontainer		.devcontainer
.github		.github
__tests__		__tests__
cucumber_tests		cucumber_tests
dist		dist
marathon_tests		marathon_tests
src		src
.gitattributes		.gitattributes
.gitignore		.gitignore
.prettierignore		.prettierignore
.prettierrc.json		.prettierrc.json
LICENSE		LICENSE
README.md		README.md
SECURITY.md		SECURITY.md
action.yml		action.yml
eslint.config.mjs		eslint.config.mjs
jest.config.js		jest.config.js
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json

Repository files navigation

xray-action

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

Setup 🛠️ •Contribute 🧬 •License 📓

Setup

Configure the workflow

Specify the action as part of your GitHub actions workflow, using aXray 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 setxrayCloud 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 failureresponseTimeout:"120000"# 2 minutes timeout

⚠️ Xray Server/DC requirestest plan,test env,revision to be defined via their custom field. See additional details on passing a customtest 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 environmentstest plan,test env,revision fields are required to be provided via their custom field. See theofficial 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:$ npmtest# Verify lint is happy$ npm run lint -- --fix

Xray

Xray website
Currently fully supporting all (non multipart) requests according toXray REST API documentation
Partially support for multipart request. Supports specifying test execution meta informationXray REST API documentation

Developed By

Other actions

License

Copyright 2025 Mike PenzLicensed 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.0Unless required by applicable law or agreed to in writing, softwaredistributed 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 andlimitations under the License.