Создание пространства кода для репозитория

Вы можете создать codespace для ветви в репозитории для разработки онлайн.

Tool navigation

В этой статье

Создание пространства кода для репозитория

Пространство кода можно создать на GitHub, в Visual Studio Codeили с помощью GitHub CLI. Используйте вкладки в этой статье, чтобы отобразить инструкции по каждому из этих способов создания пространства кода.

Вы можете использовать GitHub Codespaces в вашей личной учетной записи GitHub с квотой бесплатного использования, включенной каждый месяц для учетных записей в планах Free и Pro. Вы можете продолжать использовать GitHub Codespaces за пределами ежемесячно включенного хранилища и использования вычислений, предоставив сведения о платеже и установив ограничение расходов. См . раздел AUTOTITLE.

Организации могут разрешить членам и внешний участник совместной работы создавать и использовать пространства кода за счет организации. Дополнительные сведения см. в разделе Выбор владельцев и оплаты пространств кода в вашей организации.

Возможность создавать пространства кода из репозиториев, принадлежащих организации, зависит от нескольких факторов, в том числе видимости репозитория и параметров организации или родительского предприятия. Дополнительные сведения см. в разделе Устранение неполадок при создании и удалении codespace.

Если вы запускаете новый проект, вам может потребоваться создать пространство кода из шаблона и опубликовать в репозитории на GitHub позже. Дополнительные сведения см. в разделе Создание пространства кода на основе шаблона.

Если вы создаете пространство кода из репозитория, пространство кода будет связано с определенной ветвью, которая не может быть пустой. Для каждого репозитория и даже ветви можно создавать несколько кодовых пространств.

Вы можете увидеть все доступные пространства кода, созданные на странице "Ваши пространства кода". Чтобы отобразить эту страницу, в левом верхнем углу GitHubвыберите , а затем выберите Codespaces. Это позволит вам github.com/codespaces.

Процесс создания пространства кода

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

  • Шаг 1. Виртуальная машина и хранилище назначаются вашей среде codespace.
  • Шаг 2. Создается контейнер и клонируется репозиторий.
  • Шаг 3. Вы можете подключиться к codespace.
  • Шаг 4. Для codespace выполняется настройка после создания.

Дополнительные сведения о том, что происходит при создании пространства кода, см. в разделе Подробные сведения о GitHub Codespaces.

Дополнительные сведения о жизненном цикле пространства кода см. в разделе Общие сведения о жизненном цикле пространства кода.

Если вы хотите использовать перехватчики Git для пространства кода, необходимо настроить перехватчики с помощью devcontainer.json скриптов жизненного цикла, таких как postCreateCommand. Они выполняются на шаге 4 выше. Сведения о скриптах жизненного цикла см . в спецификации контейнеров разработки на веб-сайте "Контейнеры разработки". Так как контейнер разработки для пространства кода создается после клонированного репозитория, любой каталог шаблонов Git, настроенный в образе контейнера разработки, не будет применяться к вашему пространству кода. Вместо этого после создания codespace необходимо установить перехватчики.

Можно изменять код, отлаживать его и использовать команды Git при разработке в codespace с помощью VS Code. Дополнительные сведения см. в документации по VS Code.

Чтобы ускорить создание пространства кода, администраторы репозитория могут включить предварительные сборки GitHub Codespaces для репозитория. Дополнительные сведения см. в разделе О готовых сборках GitHub Codespaces.

Создание пространства кода для репозитория

  1. На GitHubперейдите на главную страницу репозитория.

  2. В поле имени репозитория выберите раскрывающееся меню ветви, которое помечено именем текущей ветви, а затем щелкните ветвь, для которой нужно создать пространство кода.

    Снимок экрана: раскрывающееся меню развернутой ветви, в котором перечислены различные ветви. Раскрывающееся меню "магистраль", отображаемое значком ветви, описывается оранжевым цветом.

  3. Нажмите кнопку Code , а затем перейдите на вкладку "Пространства кода".

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

    Снимок экрана: диалоговое окно "Пространства кода". Сообщение, показывающее, кто будет платить за пространство кода, выделено темно-оранжевым контуром.

  4. Создайте кодовое пространство с параметрами по умолчанию или настройте расширенные параметры:

    •      **Использование параметров по умолчанию**

      Чтобы создать пространство кода с помощью параметров по умолчанию, щелкните . 

    •      **Настройка дополнительных параметров**

      Чтобы настроить дополнительные параметры для кодового пространства, например другой тип компьютера или конкретный файл devcontainer.json, выполните следующие действия:

      1. В правом верхнем углу вкладки Codespaces выберите и нажмите кнопку "Создать с параметрами".

        Снимок экрана: раскрывающийся список параметров на вкладке "Codespaces" с выделенным параметром "Создать с параметрами".

      2. На странице параметров пространства кода выберите предпочитаемые параметры в раскрывающихся меню.

        Снимок экрана: страница расширенных параметров с кнопками "Ветвь", "Конфигурация контейнера разработки", "Регион" и "Тип компьютера".

        На странице параметров также могут отображаться имена одного или нескольких секретов, которые рекомендуется создать в параметрах Codespaces. Дополнительные сведения см. в разделе "Рекомендуемые секреты".

        Примечание.

        • Чтобы ускорить создание кодового пространства для этого репозитория и ветви, можно добавить страницу параметров можно в закладки.
        • Страница https://github.com/codespaces/new позволяет быстро создать кодовое пространство для любого репозитория и ветви. Чтобы быстро открыть эту страницу, введите codespace.new в адресную строку браузера.
        • Дополнительные сведения о файлах конфигурации контейнера разработки см. в разделе Основные сведения о контейнерах разработки.
        • Дополнительные сведения о типах компьютеров см. в разделе Изменение типа компьютера для codespace.
        • Выбор доступных типов машин может быть ограничен рядом факторов. Они могут включать политику, настроенную для вашей организации, или минимальную спецификацию типа компьютера для репозитория. Дополнительные сведения см. в разделе [AUTOTITLE и Ограничение доступа к типам компьютеров](/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/setting-a-minimum-specification-for-codespace-machines).

      3. Щелкните Create codespace (Создать codespace).

Имена определяемых пользователем секретов могут отображаться на странице расширенных параметров при создании пространства кода. Это произойдет, если рекомендуемые секреты были указаны в выбранной конфигурации контейнера разработки. Дополнительные сведения см. в разделе Указание рекомендуемых секретов для репозитория.

Screenshot of the "Create codespace" page with four recommended secrets highlighted with a dark orange outline.

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

Если ввести значение рекомендуемого секрета, секрет будет доступен в новом пространстве кода. При нажатии кнопки "Создать пространство кода" секрет также добавляется в личные параметры для Codespaces, поэтому при создании пространства кода для этого репозитория вам не потребуется ввести значение секрета в будущем.

Если имя секрета отображается с флажком, недоступным для выбора, и нет поля ввода, это связано с тем, что у вас уже есть секрет этого имени, настроенный в личных параметрах для Codespaces, и вы связали его с этим репозиторием. Если вы создали секрет этого имени, но не связали его с этим репозиторием, установите флажок, чтобы выбрать и сделать это, чтобы обновить параметры, чтобы добавить связь.

Если вы хотите изменить значение предварительно выбранного секрета, можно сделать это из личных параметров для Codespaces на github.com/settings/codespaces. Дополнительные сведения см. в разделе Управление секретами, специфичными для ваших аккаунтов, для GitHub Codespaces.

После подключения учетной записи на GitHub к расширению GitHub Codespaces можно создать новое пространство кода. Дополнительные сведения о расширении GitHub Codespaces см. в разделе VS Code Marketplace.

  1. В VS Codeв строке действий щелкните значок удаленного обозревателя.

    Снимок экрана: панель действий. Значок боковой панели "Удаленный обозреватель" (прямоугольник, наложенный кругом), выделен оранжевым контуром.

    Примечание.

    Если удаленный обозреватель не отображается в строке действий:

    1. Откройте палитру команд. Например, нажмите клавиши SHIFT+COMMAND+P (Mac) или CTRL+SHIFT+P (Windows/Linux).
    2. Введите details.
    3. Щелкните Codespaces: сведения.

  2. Наведите указатель мыши на боковую панель "Удаленный обозреватель" и щелкните .

    Снимок экрана: боковая панель "Удаленный обозреватель" для GitHub Codespaces. Подсказка "Create New Codespace" отображается рядом с кнопкой знака плюса.

  3. В текстовом поле введите имя репозитория, в который вы хотите разработать, а затем выберите его.

    Снимок экрана: "octo-org/he", введенный в текстовое поле, и список четырех репозиториев, начинающихся с этой строки.

    Сообщение отображается в правой части последующих запросов, сообщающих о том, кто будет платить за пространство кода.

    Снимок экрана: запрос на ветвь с сообщением "Использование, оплачиваемое концентратором".

  4. Щелкните ветвь, в которой нужно выполнить разработку.

  5. Если появится запрос на выбор файла конфигурации контейнера разработки, выберите файл из списка.

  6. Щелкните тип компьютера, в котором нужно выполнить разработку.

    Примечание.

    Выбор доступных типов машин может быть ограничен рядом факторов. Они могут включать политику, настроенную для вашей организации, или минимальную спецификацию типа компьютера для репозитория. Дополнительные сведения см. в разделе [AUTOTITLE и Ограничение доступа к типам компьютеров](/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/setting-a-minimum-specification-for-codespace-machines).

Примечание.

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

Чтобы создать codespace, используйте подкоманду gh codespace create.

gh codespace create

Вам будет предложено выбрать репозиторий. Отображается сообщение, указывающее, кто будет платить за пространство кода. Затем вам будет предложено выбрать ветвь, файл конфигурации контейнера разработки (если доступно несколько) и тип компьютера (если доступно несколько).

Или же можно использовать флаги для указания некоторых или всех параметров:

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.

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