Skip to content
ΛᄂΣX edited this page Dec 16, 2024 · 9 revisions

Set-up the plugin

The plugin settings reside in the Project Settings/Plugins/Bug Bridge section. Screenshot 2024-12-05 at 19 23 58

Jira

Jira Account Name

If you don't know the project name, ask your PM or if you already have access to Jira, you will find this information if you look at the Jira Url in your browser -> https://{ACCOUNT_NAME}.atlassian.net/...

Jira User Name

This is your email associated with the Jira.

Jira Api Token

Please use the convenient button Get Jira Api Token in the plugin setting or this link. Click Create API Token on the website and follow the instructions. Copy the Api Token. The result should be the website looking like this (you can use any name you want, but the app should be there)

Tip: Do not share or commit your API token in the repository

Screenshot 2024-12-03 at 16 38 31

Your projects and ticket types

Before creating tickets, you need to specify 2 things:

1. Project The plugin lists all the available options your Jira portal provides. The Key of the project is used.

2. Ticket Type The ticket types differ depending on the project type you've selected. After the board selection, the plugin gets and displays all the options your project provides.

Status

If the project and ticket types query works it's a good sign you configured everything correctly. If you get red text, the plugin will not work. Please get back to the config phase correct the information and try to get boards and ticket types again.

General | Ticket

Labels

You can define custom labels you want the created tickets to have.

Screenshot Saving

A screenshot is created right after the bug reporting window is opened and will be uploaded and attached automatically to the newly created ticket. The following options could modify how the screenshot filename will look like.

The default yields to DefaultSession_ScreenShot_2024.12.03-15.44.31.png

Screenshot 2024-12-03 at 17 12 13

Generic

Runtime - taking bugs

Open the window

The easiest option is using the console command BB.Report

Tip: Create key binding if testing on desktops, or create specific gesture if testing on mobile

Screenshot 2024-12-05 at 20 02 22

Bug submit process

Submitting bugs is done in 4 steps, following the widely used workflow many developers/QA testers follow.

  1. Provide ticket title
  2. Provide repro steps
  3. Provide current result
  4. Provide the expected result

Screenshot

The screenshot is attached automatically to the ticket. It's taken the moment the window is opened. Please see the configuration as there is an option on how you want to name the screenshots (e.g. per testing session name, etc...)

Platform info

Every platform provides different types of information. In general, you can await information about CPU, GPU, resolution, aspect ratio, OS version, and network type connection.

PLATFORM INFO:
OS Version: 14.3.1
OS Name: Mac
CPU Brand: Apple M3 Pro
CPU Vendor: Apple
GPU Brand: Apple M3 Pro
RHI Name: Metal
Native Display Resolution: 6720x3780 px
Native Aspect Ratio: 1.777778
Viewport Resolution: 1920x1081 px
Viewport Aspect Ratio: 1.776133