diff --git a/resources/integrations/jira.md b/resources/integrations/jira.md index 8f7926c..4eb3b01 100644 --- a/resources/integrations/jira.md +++ b/resources/integrations/jira.md @@ -6,15 +6,26 @@ description: >- # Jira -Currents integration for Jira allows your team to create and link test failure details directly from the Currents dashboard. Once installed and configured, team members can create new (or add comments to existing) Jira issues with full context: +Currents integration for Jira allows your team to create and link test failure details directly from the Currents dashboard. Team members can create new or add comments to existing Jira issues with full context: -* error messages, -* stack traces, -* metadata, -* and test history +- error messages, +- stack traces, +- metadata, +- and test history -without leaving Currents and simplifyingtriaging the failures by eliminates context switching. +without leaving Currents, eliminating context switching. +The integration is powered by [Currents for Jira Application](https://marketplace.atlassian.com/apps/1238333) that runs on Jira Cloud. +## Setup -The integration is powered by [Currents for Jira Application](https://marketplace.atlassian.com/apps/1238333) that runs on Jira Cloud. +1. Enable Jira Integration in project settings +2. Install [Currents for Jira](<(https://marketplace.atlassian.com/apps/1238333)>) from Atlassian Marketplace +3. Link your accounts with installation token + +See the [Setup Guide](./setup.md "mention") for complete instructions. + +## Links + +- [Setup Guide](./jira/setup.md "mention") +- [Usage Guide](./jira/usage.md "mention") diff --git a/resources/integrations/jira/setup.md b/resources/integrations/jira/setup.md index c00fc3b..5485942 100644 --- a/resources/integrations/jira/setup.md +++ b/resources/integrations/jira/setup.md @@ -4,42 +4,42 @@ description: Setup instructions for Currents integration with Jira # Setup +This guide walks you through connecting Currents to your Jira Cloud instance. + ## Requirements -The installation must be performed by an account: +You need: -* with Currents Admin permissions -* with [Jira Admin](https://www.atlassian.com/software/jira/guides/permissions/overview#what-are-users-and-groups) permissions (install and configure marketplace applications permission) +- A Jira Cloud account +- An account with Currents Admin permissions +- An account with [Jira Admin](https://www.atlassian.com/software/jira/guides/permissions/overview#what-are-users-and-groups) permissions ## Enable Jira Integration -* Open Project Integrations section (select a **Project > Integrations**) -* Click **Jira App > Add Integration** -* Click **+ Add Jira Installation** (you can have up to 3 installations) -* Change the Installation label — we commend setting it to your Jira namespace label e.g. `currents-dev.atlassian.com` -* After creating an installation get the **Installation Link Token** - you will need it later to [#link-jira-app](setup.md#link-jira-app "mention") +1. In Currents, navigate to your **Project > Integrations** +2. Click **Jira App > Add Integration** +3. Click **+ Add Jira Installation** (you can have up to 3 installations) +4. Set the Installation label to your Jira namespace (e.g., `currents-dev.atlassian.com`) +5. Copy the **Installation Link Token** - you'll need this to complete the connection ## Install Currents for Jira App -Open [Currents for Jira](https://marketplace.atlassian.com/apps/1238333) on [Atlassian Marketplace](https://marketplace.atlassian.com) (or search for `Currents` ) - -* Click **Get It Now** -* Follow the on-screen instructions +1. Go to [Currents for Jira](https://marketplace.atlassian.com/apps/1238333) on Atlassian Marketplace +2. Click **Get It Now** +3. Follow the installation wizard to complete the installation ## Link Jira App -Link the newly installed application with your Currents organization +Now connect the app to your Currents organization: -* Open **Setting** (upper right corner) **> Apps** -* Open **Manage Apps** (usually `https://.atlassian.net/plugins/servlet/upm`) -* Open **User-installed** section; then expand **Currents for Jira**, click **Configure** -* Enter the **Installation Link Token,** click **Link Installation** +1. In Jira, go to **Settings** (upper right) **> Apps** +2. Open **Manage Apps** (`https://.atlassian.net/plugins/servlet/upm`) +3. Find the **User-installed** section +4. Expand **Currents for Jira** and click **Configure** +5. Paste your **Installation Link Token** and click **Link Installation** -

Link Jira App to your Currents Organization

+
Link Jira App to your Currents Organization

Link Jira App to your Currents Organization

-

🎉 Congratulations!

- -

A successfully linked installation details will show up in Currents Dashboard.

+When successful, you'll see the linked installation details in your Currents Dashboard:
Example of successfully linked Currents integration with Jira

Example of successfully linked Currents app for Jira

- diff --git a/resources/integrations/jira/usage.md b/resources/integrations/jira/usage.md index 6061d34..f4e40f0 100644 --- a/resources/integrations/jira/usage.md +++ b/resources/integrations/jira/usage.md @@ -4,28 +4,31 @@ description: Learn how to use Currents Jira Integration # Usage -Once Currents integration with Jira is installed, you can create new issues or add comments to existing Jira issues directly from currents dashboard. +After setup, you can create new Jira issues or comment on existing ones directly from test execution details in Currents. -## Open Jira Modal +## Access Jira Features -Open the desired test execution details and note the **Jira** icon**,** the icon only appears if there Jira intergration is enabled. +1. Open any test execution details in Currents +2. Look for the **Jira** icon (only visible when integration is enabled) +3. Click the icon to open the Jira actions dialog -
+
Jira integration icon in test details
Jira integration access point
-Clicking on the icon open a window where you can: +From here, you can: -* Create a New Jira Issue -* Link an Existing Jira Issue +- Create a new Jira issue +- Link to an existing issue ## Create a New Jira Issue -To create a new Jira Issue +To create a new issue: -* Select **Jira Project** and **Issue Type** -* Enter **Issue Title** and optional **Description** -* Enable **Include Details** toggle to add contextual information about the currently presented text. +1. Select the **Jira Project** and **Issue Type** +2. Enter **Issue Title** and **Description** (optional) +3. Toggle **Include Details** to automatically add test context (error messages, stack traces, etc.) +4. Click **Create Issue** -Here's an example of an newly created issue. +Example of a newly created issue:
@@ -33,17 +36,24 @@ Here's an example of an newly created issue. ## Link to an Existing Jira Issue -To create a new Jira Issue +To link and comment on an existing issue: -* Select **Jira Project** -* Select an existing issue by typing its title and selecting it (the output is limited to 50 items, type a more specific issue title to reduce the number of results) -* Add comment content and click Add Comment -* Enable **Include Details** toggle to add contextual information about the currently presented text. +1. Select the **Jira Project** +2. Search for the issue by typing its title (results limited to 50 items) +3. Enter your comment text +4. Toggle **Include Details** to add test context +5. Click **Add Comment** +Note: For more specific results, use more detailed search terms. +Example of commenting on an existing issue: -Here's an example of new comment for an existing issue +
Adding a comment to existing Jira issue
Adding a comment in Currents
-
+
Comment appears in Jira issue
Comment appears in Jira with test context
-
+## Notes + +- The integration creates one-way links from Currents to Jira +- Jira issue status updates are not reflected back in Currents +- Comments include a link back to the specific test in Currents