Создание проекта на C# (.NET) для GitHub Codespaces

Введение

Это руководство показывает, как настроить пример проекта на C# (.NET) в GitHub Codespaces с помощью веб-клиента Visual Studio Code . Он будет выполнять шаги по открытию проекта в пространстве кода и добавлению и изменению предварительно определенной конфигурации контейнера разработки.

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

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

Шаг 1. Открытие проекта в пространстве кода

1. Войдите в GitHub.com, если вы еще этого не сделали.

2. Перейдите к https://github.com/microsoft/vscode-remote-try-dotnet.

3. Нажмите кнопку "Использовать этот шаблон", а затем нажмите кнопку "Открыть" в пространстве кода.

   

При создании пространства кода проект создается на удаленной виртуальной машине, выделенной для вас. По умолчанию контейнер для вашего кодового пространства содержит множество языков и систем выполнения, включая .NET. Он также содержит общий набор средств, таких как git, wget, rsync, openssh и nano.

Вы можете настроить свое codespace, настроив количество виртуальных ЦП и ОЗУ, добавив файлы с точкой для персонализации вашей среды или изменив установленные инструменты и скрипты. Дополнительные сведения см. в разделе Настройка codespace.

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

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

Шаг 2. Добавление конфигурации контейнера разработки

Стандартный контейнер разработки, или «dev container», для GitHub Codespaces поставляется с последней версией .NET и заранее установленными общими инструментами. Однако рекомендуется настроить собственный контейнер разработки для включения всех средств и сценариев, необходимых для проекта. Это обеспечит полностью воспроизводимую среду для всех пользователей GitHub Codespaces в репозитории.

Чтобы настроить репозиторий для использования пользовательского контейнера разработки, нужно создать один или несколько файлов devcontainer.json. Вы можете добавить их из предопределенного шаблона конфигурации в Visual Studio Codeили написать собственные. Дополнительные сведения о конфигурациях контейнеров разработки см. в разделе Основные сведения о контейнерах разработки.

1. Перейдите к Visual Studio Code Command Palette (shift+Command+P CTRL SHIFT++P / ), а затем начните вводить "добавить разработку". Щелкните "Кодовые пространства": добавление файлов конфигурации контейнера разработки.

   

2. Нажмите кнопку "Создать новую конфигурацию".

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

4. Нажмите кнопку "Показать все определения".

   

5. Введите c# и нажмите C# (.NET). Другие варианты доступны, если в проекте используются определенные инструменты. Например, C# и MS SQL.

   

6. Выберите версию .NET, которую хотите использовать для своего проекта. В этом случае выберите версию с меткой "(по умолчанию").

   

7. Отображается список дополнительных функций. Мы установим .NET CLI — командный интерфейс для разработки, сборки, запуска и публикации .NET-приложений. Чтобы установить это средство, введите dotnetи нажмите Dotnet CLIкнопку "ОК".

   

8. Отображается сообщение о том, что файл конфигурации контейнера разработки уже существует. Нажмите кнопку "Перезаписать".

   Файл devcontainer.json создается и открывается в редакторе.

Сведения о настраиваемой конфигурации контейнера разработки

При просмотре в обозревателе Visual Studio Code вы увидите, что .devcontainer каталог был добавлен в корневой каталог репозитория проекта, devcontainer.json содержащего файл. Это основной файл конфигурации для пространств кода, созданных из этого репозитория.

devcontainer.json

Добавленный devcontainer.json файл будет содержать значения для nameсвойств и features свойствimage. Некоторые дополнительные свойства, которые могут оказаться полезными, включены, но закомментированы.

Файл будет выглядеть примерно так, в зависимости от выбранного изображения:

// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/dotnet
{
  "name": "C# (.NET)",
  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
  "image": "mcr.microsoft.com/devcontainers/dotnet:0-7.0",
  "features": {
    "ghcr.io/devcontainers/features/dotnet:1": {}
  }

  // Features to add to the dev container. More info: https://containers.dev/features.
  // "features": {},

  // Use 'forwardPorts' to make a list of ports inside the container available locally.
  // "forwardPorts": [5000, 5001],
  // "portsAttributes": {
  //   "5001": {
  //     "protocol": "https"
  //   }
  // }

  // Use 'postCreateCommand' to run commands after the container is created.
  // "postCreateCommand": "dotnet restore",

  // Configure tool-specific properties.
  // "customizations": {},

  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
  // "remoteUser": "root"
}

• имя. Вы можете присвоить контейнеру разработки любое нужное имя. Предоставляется значение по умолчанию.
• изображение: имя образа в реестре контейнеров (DockerHub, GitHub Container registryили Реестр контейнеров Azure), которое будет использоваться для создания контейнера разработки для пространства кода.
• функции: список одного или нескольких объектов, каждый из которых ссылается на одну из доступных функций контейнера разработки. Функции являются автономными, общими единицами кода установки и конфигурации контейнера разработки. Они предоставляют простой способ добавления дополнительных средств, среды выполнения или библиотеки в контейнер разработки. Вы можете добавлять функции в VS Code или в редакторе devcontainer.json на GitHub. Дополнительные сведения см. на вкладке Visual Studio Code или веб-браузера в Добавление функций в файл devcontainer.json.
• ForwardPorts: все порты, перечисленные здесь, будут перенаправлены автоматически. Дополнительные сведения см. в разделе Переадресация портов в вашем codespace.
• portAttributes — это свойство сопоставляет указанный порт с одним или несколькими параметрами по умолчанию. Дополнительные сведения см. в спецификации контейнеров разработки на веб-сайте "Контейнеры разработки".
• postCreateCommand: используйте это свойство для выполнения команд после создания пространства кода. Это может быть отформатировано как строка (как описано выше), массив или объект. Дополнительные сведения см. в спецификации контейнеров разработки на веб-сайте "Контейнеры разработки".
• настройки. Это свойство позволяет настраивать определенное средство или службу при использовании для работы в пространстве кода. Например, можно настроить определенные параметры и расширения для VS Code. Дополнительные сведения см. в разделе "Поддержка средств и служб " на веб-сайте "Контейнеры разработки".
• remoteUser: по умолчанию вы работаете в качестве пользователя vscode, но при необходимости его можно установить в корневой каталог.

Полный список доступных свойств см . в спецификации контейнеров разработки на веб-сайте "Контейнеры разработки".

Дополнительные файлы конфигурации контейнера разработки

Если вы знакомы с Docker, вы можете использовать Dockerfile или Docker Compose, чтобы настроить среду пространства кода в дополнение к файлу devcontainer.json . Это можно сделать, добавив файлы Dockerfile compose.yaml вместе с файлом devcontainer.json . Дополнительные сведения см. в разделе "Использование образов,Dockerfiles" и Docker Compose на веб-сайте "Контейнеры разработки".

Шаг 3. Изменение файла devcontainer.json

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

• Перенаправьте порт, на котором приложение выполняется на удаленном компьютере, на локальный компьютер.
• Запустите dotnet restoreпосле создания контейнера разработки, чтобы восстановить зависимости, необходимые приложению.
• Автоматическое установка расширения VS Code в этом пространстве кода.

1. devcontainer.json В файле добавьте запятую после features свойства и удалите две закомментированные строки о функциях.

   JSONC

     "features": {
       "ghcr.io/devcontainers/features/dotnet:1": {}
     },
   
     // Features to add to the dev container. More info: https://containers.dev/features.
     // "features": {},
   

2. Раскомментируйте forwardPorts свойство и измените его значение только на порт 5000 .

   JSONC

   // Use 'forwardPorts' to make a list of ports inside the container available locally.
   "forwardPorts": [5000],
   

3. Раскомментируйте postCreateCommand свойство.

   JSONC

   // Use 'postCreateCommand' to run commands after the container is created.
   "postCreateCommand": "dotnet restore",
   

4. Раскомментируйте customizations свойство и измените его следующим образом, чтобы установить расширение "Проверка орфографии" VS Code .

   JSONC

   // Configure tool-specific properties.
   "customizations": {
     // Configure properties specific to VS Code.
     "vscode": {
       // Add the IDs of extensions you want installed when the container is created.
       "extensions": [
         "streetsidesoftware.code-spell-checker"
       ]
     }
   }
   

   Теперь devcontainer.json файл должен выглядеть примерно так, в зависимости от выбранного изображения:

   // For format details, see https://aka.ms/devcontainer.json. For config options, see the
   // README at: https://github.com/devcontainers/templates/tree/main/src/dotnet
   {
     "name": "C# (.NET)",
     // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
     "image": "mcr.microsoft.com/devcontainers/dotnet:0-7.0",
     "features": {
       "ghcr.io/devcontainers/features/dotnet:1": {}
     },
   
     // Use 'forwardPorts' to make a list of ports inside the container available locally.
     "forwardPorts": [5000],
     // "portsAttributes": {
     //   "5001": {
     //     "protocol": "https"
     //   }
     // }
   
     // Use 'postCreateCommand' to run commands after the container is created.
     "postCreateCommand": "dotnet restore",
   
     // Configure tool-specific properties.
     "customizations": {
       // Configure properties specific to VS Code.
       "vscode": {
         // Add the IDs of extensions you want installed when the container is created.
         "extensions": [
           "streetsidesoftware.code-spell-checker"
         ]
       }
     }
   
     // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
     // "remoteUser": "root"
   }
   

5. Сохранение изменений.

6. Перейдите к VS Code Command Palette (shift+Command+P CTRL SHIFT++P / ), а затем начните вводить "перестроить". Щелкните Codespaces: Перестроить контейнер.

   

   Совет

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

   После перестроения контейнера разработки, и пространство кода становится доступным снова, postCreateCommand будет запущено, восстановление необходимых зависимостей и расширение "Средство проверки орфографии" будет доступно для использования.

Шаг 4. Запуск приложения

В предыдущем разделе вы использовали postCreateCommand для установки набора пакетов с помощью команды dotnet restore. После установки зависимостей можно запустить приложение.

1. Запустите приложение, нажав или введя F5``dotnet watch run в терминал.

2. При запуске приложения щелкните вкладку "Порты" , щелкните правой кнопкой мыши порт 5000 и нажмите кнопку "Открыть в браузере".

   

Шаг 5. Фиксация изменений

Когда вы внесли изменения в пространство кода либо новый код, либо изменения конфигурации, вы хотите зафиксировать изменения. Фиксация изменений конфигурации в репозитории гарантирует, что любой пользователь, создающий пространство кода из этого репозитория, имеет ту же конфигурацию. Любые настройки, такие как добавление расширений VS Code, будут доступны всем пользователям.

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

Дополнительные сведения см. в разделе Использование системы управления версиями в codespace.

Следующие шаги

Теперь вы сможете добавить собственную конфигурацию контейнера разработчика в свой собственный проект на C# (.NET).

Ниже приведены дополнительные ресурсы для более сложных сценариев.

• Добавление функций в файл devcontainer.json
• Управление секретами, специфичными для ваших аккаунтов, для GitHub Codespaces
• Управление верификацией GPG для GitHub Codespaces
• Переадресация портов в вашем codespace