Import GitHub projects to the Astro IDE | Astronomer Documentation

Public Preview

This feature is in Public Preview.

Import an existing project into the Astro IDE by connecting your GitHub repository.

Connect a GitHub project

Prerequisites

A configured Astro GitHub integration.
Workspace Author permissions.
Project size under 200MB and individual file sizes under 1MB. See Project requirements.

Open the Astro IDE

From the Astro UI main menu, select Astro IDE.

Open the Projects tab

Click Projects to open the Projects tab.

Click ”+ Add Project”

Click + Add Project, then select Import Git Project from the dropdown menu.

Connect to a GitHub project

Click Connect to GitHub project…, then select a GitHub organization:

Choose your organization or personal GitHub account from the list.
Click Add an organization from GitHub if your organization is not listed, and follow the prompts.

Select repository and configure import

Select a repository.

Choose from the Repository list of options. The Astro IDE only allows you to select from repositories that the GitHub app is authorized to access.
(Optional) Enter the Astro Project Path if your Astro project is not in the repository root.
(Optional) Set a Git Branch. If not specified, the Astro IDE uses the default branch of the repository.

Connect

Click Connect to import your project. The Astro IDE can now load your repository and set up your environment.

Start a new session with your imported project

After importing your project, you can start a new session with it.

Prerequisites

You need to have an imported project in the Astro IDE. Follow the steps in Connect a GitHub project to import a GitHub project if you haven’t already.

Open the Astro IDE

From the Astro UI main menu, select Astro IDE.

Open the Projects tab

Click Projects to open the Projects tab.

Select your imported project

Click New Session next to the project you imported to start a new session with that project.

Resume a previous session

Once you have created a session with your imported project, you can close it, and later resume it. In the Astro IDE, go to the Sessions tab, and click the session you want to resume.