Сведения о создании codespace для репозитория
codespace можно создать на веб-сайте GitHub.com, в Visual Studio Code или с помощью GitHub CLI. Используйте вкладки в этой статье, чтобы отобразить инструкции для каждого из этих способов создания codespace.
Вы можете использовать GitHub Codespaces в вашей личной учетной записи GitHub.com с квотой бесплатного использования, включенной каждый месяц для учетных записей в планах Free и Pro.
Организации могут разрешить участникам и внешним участникам совместной работы создавать и использовать codespace за счет организации. Дополнительные сведения см. в разделе Включение GitHub Codespaces для организации.
Возможность создания codespace из репозиториев, принадлежащих организации, зависит от нескольких факторов, включая видимость репозитория и параметры организации или ее родительского предприятия. Дополнительные сведения см. в разделе Устранение неполадок при создании и удалении codespace.
Если вы запускаете новый проект, вы можете создать codespace на основе шаблона и опубликовать его в репозитории на GitHub позже. Дополнительные сведения см. в разделе Создание codespace на основе шаблона.
Примечание. Если вы используете интегрированную среду разработки JetBrains, вы можете использовать GitHub CLI для создания codespace. Затем можно использовать приложение Шлюза JetBrains, чтобы открыть codespace в интегрированной среде разработки JetBrains. Дополнительные сведения см. в разделе Использование GitHub Codespaces в интегрированной среде разработки JetBrains.
При создании codespace из репозитория пространство codespace будет связано с определенной ветвью, которая не может быть пустой. Для каждого репозитория и даже ветви можно создавать несколько кодовых пространств.
Все доступные среды codespace, созданные вами, можно просмотреть на github.com/codespaces.
Процесс создания codespace
При создании codespace необходимо выполнить ряд шагов, чтобы создать среду разработки и подключиться к ней.
- Шаг 1. Виртуальная машина и хранилище назначаются вашей среде codespace.
- Шаг 2. Создается контейнер и клонируется репозиторий.
- Шаг 3. Вы можете подключиться к codespace.
- Шаг 4. Для codespace выполняется настройка после создания.
Дополнительные сведения о том, что происходит при создании codespace, см. в разделе Подробные сведения о GitHub Codespaces.
Дополнительные сведения о жизненном цикле codespace см. в разделе Жизненный цикл codespace.
Если вы хотите использовать перехватчики Git для codespace, следует настроить перехватчики с помощью devcontainer.json
скриптов жизненного цикла, таких как postCreateCommand
. Они выполняются на шаге 4 выше. Сведения о скриптах жизненного цикла см. в спецификации контейнеров разработки на веб-сайте "Контейнеры разработки". Так как контейнер codespace создается после клонирования репозитория, любой каталог шаблонов Git, настроенный в образе контейнера, не будет применяться к codespace. Вместо этого после создания codespace необходимо установить перехватчики.
Можно изменять код, отлаживать его и использовать команды Git при разработке в codespace с помощью VS Code. Дополнительные сведения см. в документации по VS Code.
Чтобы ускорить создание codespace, администраторы репозитория могут включить предварительные сборки GitHub Codespaces для репозитория. Дополнительные сведения см. в разделе Сведения о предварительных сборках в GitHub Codespaces.
Создание codespace для репозитория
-
На GitHub.com перейдите на главную страницу репозитория.
-
Под именем репозитория выберите раскрывающееся меню ветвь с именем текущей ветви, а затем выберите ветвь, для которой нужно создать codespace.
-
Нажмите кнопку Код и выберите вкладку Кодовые пространства.
Если за codespaces для этого репозитория взимается плата за организацию или ее родительское предприятие, под кнопкой Создать codespace on BRANCH отображается сообщение о том, кто будет платить за codespace.
-
Создайте кодовое пространство с параметрами по умолчанию или настройте расширенные параметры:
-
Использование параметров по умолчанию
Чтобы создать codespace с помощью параметров по умолчанию, щелкните знак "плюс" (). Кроме того, если у вас нет codespace для этого репозитория, можно щелкнуть Создать codespace в BRANCH.
-
Настройка параметров
Чтобы настроить дополнительные параметры для кодового пространства, например другой тип компьютера или конкретный файл
devcontainer.json
, выполните следующие действия:-
В правом верхнем углу вкладки Codespaces выберите и щелкните Создать с параметрами.
-
На странице параметров для codespace выберите нужные параметры в раскрывающихся меню.
Примечания
- Чтобы ускорить создание кодового пространства для этого репозитория и ветви, можно добавить страницу параметров можно в закладки.
- Страница https://github.com/codespaces/new позволяет быстро создать кодовое пространство для любого репозитория и ветви. Чтобы быстро открыть эту страницу, введите
codespace.new
в адресную строку браузера. - Дополнительные сведения о файле см. в
devcontainer.json
разделе Основные сведения о контейнерах разработки. - Дополнительные сведения о типах компьютеров см. в разделе Изменение типа компьютера для codespace.
- Выбор доступных типов машин может быть ограничен рядом факторов. Это может быть политика, настроенная для вашей организации, или минимальная спецификация типа компьютера для репозитория. Дополнительные сведения см. в разделах Ограничение доступа к типам компьютеров и Настройка минимальной спецификации для компьютеров codespace.
-
Щелкните Create codespace (Создать codespace).
-
-
После подключения учетной записи в GitHub.com к расширению GitHub Codespaces можно создать новое codespace. Дополнительные сведения о расширении GitHub Codespaces см. в VS Code Marketplace.
-
В VS Code на панели действий щелкните значок Удаленного обозревателя.
Примечание. Если удаленный обозреватель не отображается на панели действий:
- Откройте палитру команд. Например, нажмите клавиши SHIFT+COMMAND+P (Mac) или CTRL+SHIFT+P (Windows/Linux).
- Введите
details
. - Щелкните Codespaces: сведения.
-
Наведите указатель мыши на боковую панель "Удаленный обозреватель" и щелкните .
-
В текстовом поле введите имя репозитория, в который нужно выполнить разработку, а затем выберите его.
Если выбранный репозиторий принадлежит организации и организация настроила codespaces для этого репозитория, который будет оплачиваться для организации или ее родительского предприятия, в последующих запросах будет отображаться сообщение о том, кто будет платить за codespace.
-
Щелкните ветвь, в которой нужно выполнить разработку.
-
Если появится запрос на выбор файла конфигурации контейнера разработки, выберите файл из списка.
-
Щелкните тип компьютера, в котором нужно выполнить разработку.
Примечание. Выбор доступных типов машин может быть ограничен рядом факторов. Это может быть политика, настроенная для вашей организации, или минимальная спецификация типа компьютера для репозитория. Дополнительные сведения см. в разделах Ограничение доступа к типам компьютеров и Настройка минимальной спецификации для компьютеров codespace.
Дополнительные сведения о GitHub CLI см. в разделе Сведения о GitHub CLI.
Чтобы создать codespace, используйте подкоманду gh codespace create
.
gh codespace create
Вам будет предложено выбрать репозиторий. Если codespace для этого репозитория оплачивается организацией или ее родительским предприятием, отображается сообщение о том, кто будет платить за codespace. Затем вам будет предложено выбрать ветвь, файл конфигурации контейнера разработки (если доступно несколько) и тип компьютера (если доступно несколько).
Или же можно использовать флаги для указания некоторых или всех параметров:
gh codespace create -r OWNER/REPO -b BRANCH --devcontainer-path PATH -m MACHINE-TYPE
Замените в этом примере owner/repo
идентификатором репозитория. Замените branch
именем ветви или полным хэшем SHA фиксации, которую вы хотите сначала извлечь в codespace. Если флаг -r
используется без флага b
, codespace создается из ветви по умолчанию.
Замените path
на путь к файлу конфигурации контейнера разработки, который планируется использовать для нового пространства кода. Если этот флаг пропущен, и доступно несколько файлов контейнера разработки, вам будет предложено выбрать один из списка. Дополнительные сведения о файле конфигурации контейнера разработки см. в разделе Основные сведения о контейнерах разработки.
Замените machine-type
допустимым идентификатором для доступного типа компьютера. Идентификаторы — это строки, такие как basicLinux32gb
и standardLinux32gb
. Тип доступных компьютеров зависит от репозитория, вашей личной учетной записи и расположения. При вводе недопустимого или недоступного типа компьютера, доступные типы отображаются в сообщении об ошибке. Если этот флаг пропущен, и доступно несколько типов компьютеров, вам будет предложено выбрать один из списка.
Подробные сведения о параметрах этой команды см. в руководстве по GitHub CLI.