|
1 | 1 | --- |
2 | | -title: GitHub Importer |
3 | | -sidebarTitle: Github Importer |
| 2 | +title: Import your GitHub data to Plane |
| 3 | +sidebarTitle: Github |
| 4 | +description: Integrate seamlessly with Jira and import issues into your Plane projects. |
4 | 5 | --- |
5 | | -<Tip>Integrations and importers are only available on the cloud version. We plan to open-source our SDKs in the near future so that the community can request or contribute integrations as needed.</Tip> |
6 | 6 |
|
7 | | -Import issues from your Github repository into Plane. |
| 7 | +<Warning> |
| 8 | +This feature is under development and has yet to be released. Stay tuned for updates! |
| 9 | +</Warning> |
8 | 10 |
|
9 | | -### GitHub Importer |
10 | | - |
11 | | -With Plane's GitHub importer, importing issues from a selected GitHub repository to a chosen project on Plane is just a few clicks away. |
12 | | - |
13 | | -This effortless process allows you to conveniently plan and adopt issues into your internal team by utilizing the powerful features of Cycles, Modules, and other tools available on Plane. |
14 | | - |
15 | | -### What will be Importing? |
16 | | - |
17 | | -We'll map the following fields in GitHub Issues to these fields in Plane: |
18 | | - |
19 | | -| **GitHub Issues** | **Plane** | |
20 | | -|-------------------|-------------| |
21 | | -| Title | Title | |
22 | | -| Description | Description | |
23 | | -| Labels | Labels | |
24 | | -| Comments | Comments | |
25 | | - |
26 | | -### Instructions to use GitHub Importer |
27 | | - |
28 | | -#### Integrate GitHub on your Workspace |
29 | | - |
30 | | -All the importers are managed under Workspace settings, to use the GitHub importer the first step is to navigate to `Workspace Settings > Integrations`. |
31 | | - |
32 | | -<Frame></Frame> |
33 | | - |
34 | | -To begin, click on the `Add Installation` button. This will prompt you to authorize your GitHub account. You can choose to grant full permission or select specific organizations based on the issues you want to import from. |
35 | | - |
36 | | -After, integrating GitHub onto your Workspace, you’ll see the integration status saying `Installed`. |
37 | | - |
38 | | -<Frame></Frame> |
39 | | - |
40 | | -### Starting the Import |
41 | | - |
42 | | -After integrating GitHub to your Workspace, navigate to the `Import/Export` tab in the workspace settings. Here, you should see a message indicating a successful connection status under the `Configure` tab. |
43 | | - |
44 | | -<Frame></Frame> |
45 | | - |
46 | | -### Choose the GitHub repository and the Plane project |
47 | | - |
48 | | -The next step is to select the GitHub repository from which you want to import issues, as well as the Plane project to which you want to import them. Finally, toggle the `Sync Issues` option to perform a final check. |
49 | | - |
50 | | -<Frame></Frame> |
51 | | - |
52 | | -### Verify the Details |
53 | | - |
54 | | -During this step, you will be able to see the number of issues, labels, and users that are being imported from the GitHub repository onto the Plane project. |
55 | | - |
56 | | -<Frame></Frame> |
57 | | - |
58 | | -### Map the users from GitHub to Plane |
59 | | - |
60 | | -While importing, you have the option to map users from GitHub to Plane, or choose not to do so. We provide you with three options: |
61 | | - |
62 | | -* Map to existing users |
63 | | -* Invite by email if the user is not already on Plane |
64 | | -* Do not import users |
65 | | - |
66 | | -<Frame></Frame> |
67 | | - |
68 | | -### Confirm, Import and Refresh |
69 | | - |
70 | | -The final step is to hit `Confirm` in order to import your GitHub data onto Plane. The import process may take anywhere from 1 to 5 minutes depending on the number of issues in the GitHub repository. |
71 | | - |
72 | | -<Frame></Frame> |
73 | | - |
74 | | - |
75 | | -<Frame></Frame> |
76 | | - |
77 | | -### Verifying your Imports |
78 | | - |
79 | | -When you navigate to the Plane project where you have imported the GitHub issues, you will see all the new issues from GitHub labeled as `GitHub-Migrated`. This label will indicate that these issues have been moved without raising conflicts with existing issues. |
80 | | - |
81 | | -<Frame></Frame> |
82 | | - |
83 | | -All the properties mentioned above, including comments, will be imported. |
84 | | - |
85 | | -<Frame></Frame> |
86 | | - |
87 | | -<Tip>Please note that the importer services are still a work in progress. We plan to make this open-source soon and will also extend its features based on community requirements.</Tip> |
0 commit comments