📚 Comprehensive Guide

Welcome to the official documentation for Appium Test Results for Jira. This guide will walk you through setting up the integration, embedding it into your CI/CD pipelines, and troubleshooting common issues.

📋 Prerequisites

Before you begin, ensure you have:

• Jira Cloud: Administrator or Site Admin permissions to install apps from the Atlassian Marketplace.
• WebdriverIO Project: A working mobile automation project using WebdriverIO (v7 or v8+).
• Node.js: Installed in your local/CI environment.

🛠 Part 1: Initial Setup

Step 1: Generate Your Secure Webhook

1. Install Appium Test Results for Jira from the Atlassian Marketplace.
2. Inside your Jira instance, navigate to the top navigation bar and click Apps -> Appium to Jira Config.
3. You will see a dedicated configuration page. Copy the automatically generated Webhook URL and Security Token. (Note: Keep this token secure. Do not commit it directly to public repositories).

Step 2: Add the Custom Reporter to Your Project

Our integration uses a native WebdriverIO custom reporter to listen to your test execution without slowing it down.

1. In your mobile testing repository, install the standard WebdriverIO spec-reporter (required for terminal output):

npm install @wdio/spec-reporter --save-dev

1. Create a new file in the root directory of your project (where your package.json is located) and name it wdio-jira-reporter.js.
2. Paste the JavaScript reporter code provided on your Jira Configuration page into this file.

Step 3: Update wdio.conf.js