Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jira importer #161

Merged
merged 11 commits into from
Jan 29, 2025
100 changes: 97 additions & 3 deletions docs/importers/jira-imp.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,100 @@
---
title: Jira Importer
sidebarTitle: Jira
title: Jira
---
Coming very soon.

# Import your Jira data to Plane

With the Jira importer, you can easily import issues, states, labels, priorities and user data from Jira to Plane and continue managing your existing projects.

## Import from Jira
> **Role**: Workspace admins

To import Jira issues to a Plane project, follow these steps:
1. Click the **∨** icon next to your workspace name on the sidebar and select **Workspace Settings**.

2. Select **Imports** on the right pane and click the **Import** button in the Jira section.
![Import from Jira](https://media.docs.plane.so/importers/jira/import-jira.webp#center)

4. In the **Jira to Plane Migration Assistant** screen, enter your **Personal Access Token**, **User email** and the **Jira domain** to allow Plane access to your Atlassian account.

5. Click the **Connect Jira** button to link the accounts.

6. Click the **Import** button.
![Connect Jira](https://media.docs.plane.so/importers/jira/import-jira-data.webp#center)

7. **Configure Plane**
Select the Plane project where you want to import your Jira data and and click **Next**.
![Configure Plane](https://media.docs.plane.so/importers/jira/configure-plane.webp#center)

8. **Configure Jira**
Choose the workspace and project in Jira from where you want to import data.
![Configure Jira](https://media.docs.plane.so/importers/jira/configure-jira.webp#center)

:::info[Issue types]
If you're on a paid plan (Pro or higher), issue types in Jira will be imported as issue types in Plane. On the free plan, issue types from Jira won't be imported.
:::

10. **Import users**
Choose one of the following:
- **Upload CSV**
Click the **Upload CSV** button to import users to your Plane project. Refer to [Export users from a site](https://support.atlassian.com/organization-administration/docs/export-users-from-a-site/) to download the CSV file from Jira. *(recommended)*
- **Skip user import**
You can select the **Skip Importing User data** checkbox and manually add users later.
:::warning
If you skip user import, issues and comments will show the name of the person who performed the migration, and the Assignees field will be empty.
:::
![Import users](https://media.docs.plane.so/importers/jira/import-users.webp#center)

10. **Map states**
1. Map **Jira status** to their equivalent **Plane states**.
2. Select the **Auto create and map the remaining Jira states** checkbox to automatically create and map any missing states.
![Map states](https://media.docs.plane.so/importers/jira/map-states.webp#center)

11. **Map priorities**
Map the **Jira priorities** to the corresponding **Plane priorities**. If there's no match, select **None** in the **Plane priorities** list.
![Map priorities](https://media.docs.plane.so/importers/jira/map-priorities.webp#center)

12. **Summary**
Review the mappings and make any changes if needed. Click **Back** to adjust, or click **Confirm** to start the migration.
![Review mappings](https://media.docs.plane.so/importers/jira/import-summary.webp#center)

13. The data migration begins and takes a few minutes to complete depending on the number of issues in your Jira workspace.
![Migration complete](https://media.docs.plane.so/importers/jira/import-complete.webp#center)

14. Once it's done, go to **Issues** in your Plane project to confirm that the data import is successful.

## Imported entities

Here’s a quick look at what gets imported during the migration from Jira to Plane:

| Jira | Plane | Notes|
|--------------| ------------------- |---- |
| Labels | Labels | |
| Status | States | |
| Issue priorities | Priorities | |
| Users | Users | |
| Issues | Issues | |
| Relations | Parent | Includes only parent-child relationships |
| Issue comments | Issue comments |Includes username and timestamp. If you skip user import during migration, comments will show the name of the user who performed the migration.|
| Issue attachments | Issue attachments | |
| Reporter | Created by | |
| Created | Created at | |
| Assignee | Assignees | If you skip user import during migration, this will be blank.|
| Issue types | Labels \| Prefix in Issue title | |
| Images in the Issue description | Images in the Issue description | |
| Summary | Issue title | |
| Start date | Start date | |
| Due date | Due date | |
| Linked Issues | Links | Includes backlinks to the original Jira issue.|
| Sprint | Cycles | Includes the issues, start and end date. |
| Components | Modules | Includes the issues. |

## Sync Jira to Plane

After the import, if there are any new or updated issues in Jira, you can easily sync these changes to Plane:

1. Go to **Workspace settings**.
2. Select **Imports** on the right pane.
3. Click the **Re run** button next to the project you want to sync.
![Sync Jira](https://media.docs.plane.so/importers/jira/sync-jira.webp#center)

98 changes: 94 additions & 4 deletions docs/plane-importers/jira-imp.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,100 @@
---
title: Jira
hide_title: true
---

# Import your Jira data to Plane

:::info
The Jira importer is currently available under a feature flag. Contact our support team if you’d like to try it out.
:::
With the Jira importer, you can easily import issues, states, labels, priorities and user data from Jira to Plane and continue managing your existing projects.

## Import from Jira
> **Role**: Workspace admins

To import Jira issues to a Plane project, follow these steps:
1. Click the **∨** icon next to your workspace name on the sidebar and select **Workspace Settings**.

2. Select **Imports** on the right pane and click the **Import** button in the Jira section.
![Import from Jira](https://media.docs.plane.so/importers/jira/import-jira.webp#center)

4. In the **Jira to Plane Migration Assistant** screen, enter your **Personal Access Token**, **User email** and the **Jira domain** to allow Plane access to your Atlassian account.

5. Click the **Connect Jira** button to link the accounts.

6. Click the **Import** button.
![Connect Jira](https://media.docs.plane.so/importers/jira/import-jira-data.webp#center)

7. **Configure Plane**
Select the Plane project where you want to import your Jira data and and click **Next**.
![Configure Plane](https://media.docs.plane.so/importers/jira/configure-plane.webp#center)

8. **Configure Jira**
Choose the workspace and project in Jira from where you want to import data.
![Configure Jira](https://media.docs.plane.so/importers/jira/configure-jira.webp#center)

:::info[Issue types]
If you're on a paid plan (Pro or higher), issue types in Jira will be imported as issue types in Plane. On the free plan, issue types from Jira won't be imported.
:::

10. **Import users**
Choose one of the following:
- **Upload CSV**
Click the **Upload CSV** button to import users to your Plane project. Refer to [Export users from a site](https://support.atlassian.com/organization-administration/docs/export-users-from-a-site/) to download the CSV file from Jira. *(recommended)*
- **Skip user import**
You can select the **Skip Importing User data** checkbox and manually add users later.
:::warning
If you skip user import, issues and comments will show the name of the person who performed the migration, and the Assignees field will be empty.
:::
![Import users](https://media.docs.plane.so/importers/jira/import-users.webp#center)

10. **Map states**
1. Map **Jira status** to their equivalent **Plane states**.
2. Select the **Auto create and map the remaining Jira states** checkbox to automatically create and map any missing states.
![Map states](https://media.docs.plane.so/importers/jira/map-states.webp#center)

11. **Map priorities**
Map the **Jira priorities** to the corresponding **Plane priorities**. If there's no match, select **None** in the **Plane priorities** list.
![Map priorities](https://media.docs.plane.so/importers/jira/map-priorities.webp#center)

12. **Summary**
Review the mappings and make any changes if needed. Click **Back** to adjust, or click **Confirm** to start the migration.
![Review mappings](https://media.docs.plane.so/importers/jira/import-summary.webp#center)

13. The data migration begins and takes a few minutes to complete depending on the number of issues in your Jira workspace.
![Migration complete](https://media.docs.plane.so/importers/jira/import-complete.webp#center)

14. Once it's done, go to **Issues** in your Plane project to confirm that the data import is successful.

## Imported entities

Here’s a quick look at what gets imported during the migration from Jira to Plane:

| Jira | Plane | Notes|
|--------------| ------------------- |---- |
| Labels | Labels | |
| Status | States | |
| Issue priorities | Priorities | |
| Users | Users | |
| Issues | Issues | |
| Relations | Parent | Includes only parent-child relationships |
| Issue comments | Issue comments |Includes username and timestamp. If you skip user import during migration, comments will show the name of the user who performed the migration.|
| Issue attachments | Issue attachments | |
| Reporter | Created by | |
| Created | Created at | |
| Assignee | Assignees | If you skip user import during migration, this will be blank.|
| Issue types | Labels \| Prefix in Issue title | |
| Images in the Issue description | Images in the Issue description | |
| Summary | Issue title | |
| Start date | Start date | |
| Due date | Due date | |
| Linked Issues | Links | Includes backlinks to the original Jira issue.|
| Sprint | Cycles | Includes the issues, start and end date. |
| Components | Modules | Includes the issues. |

## Sync Jira to Plane

After the import, if there are any new or updated issues in Jira, you can easily sync these changes to Plane:

1. Go to **Workspace settings**.
2. Select **Imports** on the right pane.
3. Click the **Re run** button next to the project you want to sync.
![Sync Jira](https://media.docs.plane.so/importers/jira/sync-jira.webp#center)

26 changes: 26 additions & 0 deletions docs/plane-importers/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: Overview
---

import {CardGroup,Card} from '@site/src/components';

Plane's importers simplify the process of migrating project data from other tools. Instead of manually recreating your project structure and history, you can transfer existing issues, workflows, and project details directly into Plane.

Switching tools shouldn’t mean starting over. With Plane importers, you can effortlessly migrate your data, preserving your team’s progress and ensuring a smooth transition.


<CardGroup cols={2}>
<Card title="Asana" svg={<svg width="112" height="22" fill="#3e76ff" xmlns="http://www.w3.org/2000/svg" aria-labelledby="asana"><path class="_nav_logo-link__asana-icon__Un0sE" id="asana-horizontal-logo__icon" d="M18.559 11.605a5.158 5.158 0 1 0 0 10.317 5.158 5.158 0 0 0 0-10.317Zm-13.401.001a5.158 5.158 0 1 0 0 10.315 5.158 5.158 0 0 0 0-10.315Zm11.858-6.448a5.158 5.158 0 1 1-10.316 0 5.158 5.158 0 0 1 10.316 0Z" fill="#3e76ff"></path></svg>} href="/plane-integrations/asana-importer">
Integrate Plane with Github to automatically capture issues from github. We will expand this to support sync of PRs with Plane issues.
</Card>

<Card title="Jira" icon="FaJira" href="/plane-integrations/jira-imp">
Integrate Plane with Github to automatically capture issues from github. We will expand this to support sync of PRs with Plane issues.
</Card>

<Card title="Linear" svg={<svg height="21" viewBox="0 0 500 100" fill="#3e76ff" size="16" color="#3e76ff" aria-label="Linear"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.9266 16.3713c-.5283.5806-.4933 1.4714.0617 2.0265l68.5946 68.5946c.5551.555 1.4459.59 2.0265.0617 10.0579-9.1522 16.3713-22.3478 16.3713-37.0179C99.9807 22.402 77.5788 0 49.9445 0 35.2744 0 22.0788 6.31337 12.9266 16.3713ZM4.35334 29.3894c-.25348.5589-.12567 1.2142.30824 1.6481L68.9432 95.3191c.4339.4339 1.0892.5617 1.6481.3083 1.485-.6736 2.9312-1.4176 4.3344-2.2277.8341-.4815.9618-1.6195.2808-2.3005L8.88146 24.7742c-.68097-.681-1.81894-.5532-2.30045.2808-.81013 1.4032-1.55411 2.8494-2.22767 4.3344ZM.453579 47.796c-.300979-.301-.46112014-.7158-.4327856-1.1405.1327026-1.9891.3816396-3.9463.7400796-5.865.214926-1.1505 1.620727-1.5497 2.448307-.7222L59.9124 96.7715c.8275.8276.4283 2.2334-.7222 2.4483-1.9187.3585-3.8759.6074-5.865.7401-.4247.0283-.8395-.1318-1.1405-.4328L.453579 47.796ZM3.93331 61.7589c-1.0331-1.0331-2.70028-.1429-2.32193 1.2683C6.22104 80.2203 19.7604 93.7597 36.9535 98.3693c1.4112.3784 2.3014-1.2888 1.2683-2.3219L3.93331 61.7589ZM201.602"></path></svg>} href="/plane-integrations/slack-importer">
Integrate Plane with Slack to forward issue updates from plane to github. We will expand this to support creating issues from slack soon.
</Card>

</CardGroup>

3 changes: 1 addition & 2 deletions sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -147,8 +147,7 @@ const sidebars: SidebarsConfig = {
collapsed: true,
label: 'Importers',
items: [
'plane-importers/github-imp',
'plane-importers/jira-imp',
'importers/jira-imp',
],
},
{
Expand Down