Указание рекомендуемых секретов для репозитория

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

Кто эту функцию можно использовать?

People with write permissions to a repository can create or edit the codespace configuration.

В этой статье

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

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

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

Рекомендуемые секреты перечислены в нижней части страницы.

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

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

Каждый рекомендуемый секрет отображается одним из трех способов:

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

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

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

  1. Вы можете настроить пространства кода, созданные для репозитория, добавив параметры в devcontainer.json файл. Если репозиторий еще не содержит devcontainer.json файл, его можно добавить. См. раздел "Добавление конфигурации контейнера разработки в репозиторий".

  2. Измените devcontainer.json файл, добавив secrets свойство на верхнем уровне файла в вложенный объект JSON. Например:

    JSON
    "secrets": {
  "NAME_OF_SECRET_1": {
    "description": "This is the description of the secret.",
    "documentationUrl": "https://example.com/link/to/info"
  },
  "NAME_OF_SECRET_2": { }
}

  3. Добавьте свойство внутри secrets каждого секрета, который вы хотите рекомендовать. Например, измените NAME_OF_SECRET_1 и NAME_OF_SECRET_2в предыдущем примере кода на имена секретов, которые люди должны создавать в личных параметрах для Codespaces.

  4. При необходимости укажите описание каждого секрета и URL-адрес для получения дополнительных сведений об этом секрете.

    Вы можете опустить description и documentationUrl, как показано NAME_OF_SECRET_2 в предыдущем примере кода.

  5. Укажите дополнительные секреты по мере необходимости.

  6. Сохраните файл и зафиксируйте изменения в требуемой ветви репозитория.

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