diff --git a/astro.config.mjs b/astro.config.mjs index dab5881f..8174100b 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -87,6 +87,7 @@ export default defineConfig({ label: 'Tutorials', items: [ { label: 'Overview', link: '/tutorials'}, + { label: 'Working With Jira', link: '/tutorials/working-with-jira'}, { label: 'Playwright', link: '/tutorials/playwright'}, { label: 'Java Integration', link: '/tutorials/java'}, { label: 'WebdriverIO', link: '/tutorials/webdriver'}, diff --git a/src/content/docs/tutorials/Working-with-Jira.md b/src/content/docs/tutorials/Working-with-Jira.md new file mode 100644 index 00000000..069b4411 --- /dev/null +++ b/src/content/docs/tutorials/Working-with-Jira.md @@ -0,0 +1,125 @@ +--- +title: Working with Jira +description: Learn how to work with Jira in Testomat.io. This guide walks you through connecting your project to Jira, linking tests, suites, and plans to Jira issues, creating issues from failed tests, running tests directly from Jira, attaching reports, and tracking coverage with the traceability matrix. +type: article +url: https://docs.testomat.io/tutorials/working-with-jira +head: + - tag: meta + attrs: + name: og:image + content: https://docs.testomat.io/_astro/New_b1BS3EKN_2024-08-29.DGrFkMLR_ZOOgn1.webp + + - tag: meta + attrs: + name: keywords + content: Jira, Testomat.io, Jira plugin, Jira integration, test management, link tests to issues, Jira issues, defects, bug tracking, traceability matrix, test runs in Jira, test reports, sprints, QA +--- + +Welcome! + +This tutorial connects Testomat.io to Jira and walks you through the everyday flow: link a test to a Jira issue, report a defect from a run, and see testing status back in Jira. Once this is set up, tests and Jira issues stay tied together, so the team can see what is tested and what is failing. + +![Jira - Testomat.io integration flow](./images/working-with-jira/testomatio-jira-flow.png) + +What you will do: + +1. Connect your Jira project. +2. Link a test to a Jira issue. +3. Report a defect from a run. +4. See the status synced back in Jira. + +## Before you start + +Make sure you have: + +* Jira profile access, with administrator rights in the Jira workspace. +* A Manager or Owner role in your Testomat.io project. +* The [Testomat.io Jira Plugin](https://docs.testomat.io/advanced/jira-plugin/) is installed in Jira. + +:::note + +Connecting requires Jira admin rights. The person who sets up the integration in Project Settings must have them, or the project cannot be connected. See [Integrations](https://docs.testomat.io/integrations/issues-management/jira) for the full reference. + +::: + +## Connect your Jira project + +1. In your Testomat.io project, open **Settings** in the sidebar. +2. Click **Jira Integration**. +3. Click **Add Jira project**. +4. In the **New Jira project** panel, select the connection type and enter the details. + +![Jira Integration settings with the Add Jira project button](./images/working-with-jira/1-new-jira-project.png) + +Pick the connection type based on who should see testing data in Jira: + +| The account type | Tests and results are visible to | +|---|---| +| **Administrator account** | Linked tests and results are visible to all Jira users through the plugin, while editing and running still require a Testomat.io login.

Use this if you want everyone in Jira to see coverage. | +| **Regular account** | Linked tests and results are visible only to logged-in Testomat.io users.

Use this if you need to restrict access. | + +Once saved, your Jira project is connected and ready. + +## Link a test to a Jira issue + +Linking ties a test to the story or bug it covers, so coverage shows on both sides. + +1. Select the test, or several tests, on the Tests page. +2. Click **Link**. +3. Type in the Jira issue to link them to. + +![The Link to Issue button and the Jira issue picker](./images/working-with-jira/2-link-to-issue.png) + +The link now appears on both the test and the Jira issue. You can also link a test to the Jira issue by hovering over the test and clicking the link icon. + +:::note + +You can also link tests from inside Jira. The [Jira Plugin](https://docs.testomat.io/advanced/jira-plugin/) lets you link and unlink tests, suites, and plans to an issue without leaving Jira. + +::: + +## Report a defect from a run + +When a test fails during a run, you can create a Jira bug without leaving Testomat.io. + +1. In the run, open the failed test. +2. Choose to report a defect and enter the Jira issue link. +3. If needed, you can create a new issue and link the defect to it: + 1. Click **Create new issue**. + 2. Select **Jira profile** and **Jira Issue type**. + 3. Enter the issue **Title** and **Description**. + +![Create new Jira issue in Testomat.io](./images/working-with-jira/3-link-defect.png) + +4. Click **Create Jira issue**. The new issue has been created in Jira and linked to the test. + +![Reporting a defect to Jira from a failed test in a run](./images/working-with-jira/4-create-new-issue.png) + +:::note + +To prefill the bug summary and description, set up a Defect template first. See [Templates](https://docs.testomat.io/management/project/templates/#applying-templates-to-defects). + +::: + +## See the status synced back in Jira + +With the plugin in place, your Jira issues show the linked tests and their latest results, so a product owner can open an issue and see whether it passed or failed. + +1. Open the linked issue in Jira. +2. View the Testomat.io panel to see linked tests, coverage, and the latest run status. + +![Testomat.io panel inside a Jira issue showing linked tests and status](./images/working-with-jira/5-jira-issue-w-testomatio-panel.png) + +With the [Jira Plugin](https://docs.testomat.io/advanced/jira-plugin/) in place, your Jira issues show the linked tests and their latest results, so a product owner can open an issue and see whether it passed or failed. + +If something looks out of date, use [Synchronize with Jira](https://docs.testomat.io/integrations/issues-management/jira/#how-to-connect-to-jira-project) from the integration to refresh the link. + +The link between the test and the Jira issue can be viewed in the run next to the reported defect. + +![Run view with the defect reported in Jira](./images/working-with-jira/6-test-connected-to-jira.png) + +## Next steps + +* Want cleaner bug reports? Set up a [Defect](https://docs.testomat.io/management/project/templates/#applying-templates-to-defects) template in Templates. +* Setting up other tools? See [Integrations](https://docs.testomat.io/integrations/issues-management/). +* Working mostly inside Jira? See the [Jira Plugin](https://docs.testomat.io/advanced/jira-plugin/) for running tests and managing suites without leaving Jira. \ No newline at end of file diff --git a/src/content/docs/tutorials/images/working-with-jira/1-new-jira-project.png b/src/content/docs/tutorials/images/working-with-jira/1-new-jira-project.png new file mode 100644 index 00000000..d3841acf Binary files /dev/null and b/src/content/docs/tutorials/images/working-with-jira/1-new-jira-project.png differ diff --git a/src/content/docs/tutorials/images/working-with-jira/2-link-to-issue.png b/src/content/docs/tutorials/images/working-with-jira/2-link-to-issue.png new file mode 100644 index 00000000..c5d14cca Binary files /dev/null and b/src/content/docs/tutorials/images/working-with-jira/2-link-to-issue.png differ diff --git a/src/content/docs/tutorials/images/working-with-jira/3-link-defect.png b/src/content/docs/tutorials/images/working-with-jira/3-link-defect.png new file mode 100644 index 00000000..66b18c18 Binary files /dev/null and b/src/content/docs/tutorials/images/working-with-jira/3-link-defect.png differ diff --git a/src/content/docs/tutorials/images/working-with-jira/4-create-new-issue.png b/src/content/docs/tutorials/images/working-with-jira/4-create-new-issue.png new file mode 100644 index 00000000..336d0b8e Binary files /dev/null and b/src/content/docs/tutorials/images/working-with-jira/4-create-new-issue.png differ diff --git a/src/content/docs/tutorials/images/working-with-jira/5-jira-issue-w-testomatio-panel.png b/src/content/docs/tutorials/images/working-with-jira/5-jira-issue-w-testomatio-panel.png new file mode 100644 index 00000000..0f855343 Binary files /dev/null and b/src/content/docs/tutorials/images/working-with-jira/5-jira-issue-w-testomatio-panel.png differ diff --git a/src/content/docs/tutorials/images/working-with-jira/6-test-connected-to-jira.png b/src/content/docs/tutorials/images/working-with-jira/6-test-connected-to-jira.png new file mode 100644 index 00000000..0420c481 Binary files /dev/null and b/src/content/docs/tutorials/images/working-with-jira/6-test-connected-to-jira.png differ diff --git a/src/content/docs/tutorials/images/working-with-jira/testomatio-jira-flow.png b/src/content/docs/tutorials/images/working-with-jira/testomatio-jira-flow.png new file mode 100644 index 00000000..758ac863 Binary files /dev/null and b/src/content/docs/tutorials/images/working-with-jira/testomatio-jira-flow.png differ