Использование GitHub Codespaces в интегрированной среде разработки JetBrains

Сведения о Codespaces в МД JetBrains

Если вы используете интегрированную среду разработки JetBrains для работы с кодом, вы можете воспользоваться преимуществами работы в codespace. Для этого используется приложение шлюза JetBrains.

После установки шлюза JetBrains можно задать JetBrains в качестве редактора по умолчанию, а затем при каждом открытии пространства кода из GitHub.com будет запускаться шлюз JetBrains, позволяющий выбрать интегрированную среду разработки JetBrains и подключиться к пространству кода.

Процесс удаленного подключения к JetBrains

Ниже приведен основной процесс использования codespace в интегрированной среде разработки JetBrains.

• В приложении шлюза JetBrains вы выбираете одно из активных или остановленных кодовых пространств.
• Затем вы выбираете, какую интегрированную среду разработки JetBrains вы хотите использовать.
• Затем выбранная интегрированная среда разработки JetBrains загружается на удаленную виртуальную машину, на которую размещается codespace и исходный код.
• Затем тонкое клиентское приложение JetBrains загружается на локальный компьютер и запускается.
• Клиентское приложение подключается к полной внутренней интегрированной среде разработки.
• Вы можете работать с кодом в клиентском приложении так же, как и в локальной среде.

Предварительные требования

Для работы в codespace в интегрированной среде разработки JetBrains вам потребуется:

• Действительная лицензия JetBrains
• Приложение шлюза JetBrains
• GitHub CLI версии 2.18.0 или более поздней
• Существующее пространство кода, на котором выполняется SSH-сервер

Лицензия JetBrains

У вас должна быть лицензия JetBrains, поддерживающая интегрированную среду разработки, выбранную в шлюзе JetBrains.

Шлюз JetBrains

Вы можете установить и обновить шлюз JetBrains из приложения JetBrains Toolbox.

1. Скачайте и установите панель элементов JetBrains.

2. Откройте панель элементов JetBrains.

3. Найдите Шлюз в списке доступных средств и нажмите кнопку Установить.

   

GitHub CLI

Для подключаемого модуля GitHub Codespaces для шлюза JetBrains необходимо установить и настроить GitHub CLI версии 2.18.0 или более поздней перед открытием codespace из шлюза JetBrains.

Используйте эту команду, чтобы проверить версию GitHub CLI:

gh --version

Дополнительные сведения см. в разделе Сведения о GitHub CLI.

Codespace, на котором выполняется SSH-сервер

У вас должно быть существующее пространство кода для подключения. codespace можно создать на веб-сайте GitHub.com, в Visual Studio Code или с помощью GitHub CLI. Дополнительные сведения см. в разделе Создание codespace для репозитория.

Пространство кода, к которому вы подключаетесь, должно работать на SSH-сервере. Образ контейнера по умолчанию включает SSH-сервер, который запускается автоматически. Если codespaces не создаются из образа по умолчанию, можно установить и запустить сервер SSH, добавив следующую команду в features объект в файле devcontainer.json .

"features": {
    ...
    "ghcr.io/devcontainers/features/sshd:1": {
        "version": "latest"
    },
    ...
}

Дополнительные сведения о devcontainer.json файле и образе контейнера по умолчанию см. в разделе Основные сведения о контейнерах разработки.

Настройка шлюза JetBrains

При первом использовании шлюза JetBrains для GitHub Codespaces необходимо установить подключаемый модуль Codespaces. Кроме того, необходимо разрешить шлюзу JetBrains доступ к GitHub.com с помощью учетной записи GitHub.

1. Откройте приложение Шлюз JetBrains.

2. В разделе Установить другие поставщики щелкните ссылку Установить для GitHub Codespaces.

   

3. Щелкните Подключиться к Codespace.

   

4. В диалоговом окне "Добро пожаловать в шлюз JetBrains" щелкните Войти с помощью GitHub.

5. Щелкните значок рядом с одноразовым кодом, чтобы скопировать его, а затем щелкните ссылку для входа.

   

6. Если вы еще не вошли в GitHub, отобразится страница входа.

   • Введите свои данные и нажмите кнопку Войти.
   • Проверьте проверку подлинности, например введя код двухфакторной проверки подлинности.

7. На странице "Активация устройства" вставьте скопированный код и нажмите кнопку Продолжить.

8. Если вы принадлежите к организациям, отобразится страница "Единый вход в организации". Щелкните Авторизовать рядом с организациями, к которым вы хотите авторизовать доступ к шлюзу JetBrains, а затем нажмите кнопку Продолжить.

9. На странице "Авторизация GitHub Codespaces для JetBrains" щелкните Авторизовать GitHub.

10. Вернитесь в приложение шлюза JetBrains и откройте codespace из списка активных или остановленных кодовых пространств. См. шаг 3 следующей процедуры.

Открытие codespace в интегрированной среде разработки JetBrains

Если вы задали шлюз JetBrains в качестве редактора по умолчанию, шлюз запустится автоматически при открытии codespace из GitHub.com.

Если шлюз JetBrains не является редактором по умолчанию, вы по-прежнему можете открыть codespace в JetBrains, перейдя на страницу "Ваши codespaces" в github.com/codespaces и щелкнув многоточие (...) справа от codespace, которое вы хотите открыть. Дополнительные сведения см. в разделе Открытие существующего codespace.

Кроме того, можно открыть шлюз JetBrains и выбрать существующее пространство кода, как описано в следующей процедуре.

1. Откройте приложение Шлюз JetBrains.

2. Щелкните Подключиться к Codespaces.

   

3. В списке "Ваши codespaces" выберите codespace, с которым вы хотите работать.

   

4. В списке "Доступные IDE" щелкните интегрированную среду разработки JetBrains, которую вы хотите использовать. Шлюз запомнит ваш выбор при следующем подключении к codespace.

   

5. Нажмите кнопку Соединить.

   Примечания

   • Если вы выбрали Rider в качестве интегрированной среды разработки JetBrains и репозиторий содержит несколько файлов решения, появится диалоговое окно "Задать путь к решению" с предложением выбрать решение, в котором вы хотите работать. Выберите файл решения в раскрывающемся меню и нажмите кнопку ОК.

     Если в репозитории нет файла решения, Rider откроется в базовом представлении каталога проекта и будет иметь ограниченные возможности. Например, вы не получите . Навигация по коду для NET. Если в репозитории есть только один файл решения, он будет использоваться автоматически без отображения запроса. Дополнительные сведения см. в разделе Создание и открытие проектов и решений в документации по JetBrains.
     
     

   • Если вы используете брандмауэр, при первом подключении к удаленному ресурсу может появиться запрос на разрешение шлюзу JetBrains взаимодействовать по сети.

   При первом подключении к codespace серверная интегрированная среда разработки будет загружена на удаленный компьютер. Это может занять несколько минут. При следующем подключении к тому же codespace этот шаг не потребуется, что ускорит процесс подключения.

   Затем запускается серверная интегрированная среда разработки. Опять же, этот шаг не потребуется в будущем, если вы будете повторно подключаться к внутренней интегрированной среде разработки, которая осталась запущенной.

   Затем запускается клиентское приложение.

Дополнительные материалы

• "Разработка в codespace"
• "Использование подключаемого модуля GitHub Codespaces для JetBrains"
• "Using GitHub Codespaces in your JetBrains IDE"