Сведения о рекомендуемых секретах
Если для проекта требуется настроить секреты для конкретного пользователя, вы можете предложить пользователям сделать это при создании пространства кода. Для этого добавьте параметр в файл конфигурации контейнера разработки для репозитория.
После указания рекомендуемых секретов, если пользователи еще не создали эти секреты в личных параметрах для Codespaces, им будет предложено сделать это при использовании расширенного метода параметров создания пространства кода. Это делается на GitHub путем нажатия кнопки Code , а затем щелкните вкладку Codespaces , а затем выберите и нажмите кнопку "Создать с параметрами".
Рекомендуемые секреты перечислены в нижней части страницы.
Note
Имена рекомендуемых секретов отображаются только на этой странице, если конфигурация контейнера в выбранной ветви указывает эти секреты.
Каждый рекомендуемый секрет отображается одним из трех способов:
- Если пользователь не установил рекомендуемый секрет в параметрах Codespaces, отображается поле ввода, позволяющее им создать секрет. Если вы настроили их, отображается описание и ссылка на дополнительные сведения. Ввод значения является необязательным.
- Если пользователь уже создал рекомендуемый секрет, но не связыв его с этим репозиторием, он может установить флажок, чтобы добавить эту связь. Это необязательно.
- Если пользователь уже создал рекомендуемый секрет и связал его с этим репозиторием, отобразится предварительно выбранный флажок.
Указание рекомендуемых секретов для проекта
Следует использовать рекомендуемые секреты для секретов среды разработки, которые должны предоставлять пользователь, создающий пространство кода, а не владелец репозитория или организации. Например, если у вас есть открытый проект, и пользователи должны предоставить личный ключ API для запуска приложения в проекте, можно указать рекомендуемый секрет, чтобы пользователи могли предоставить ключ в качестве значения секрета при использовании страницы расширенных параметров для создания пространства кода.
Кроме того, для секретов среды разработки, предоставляемых владельцем репозитория или организации, например ключами API, общими для группы, можно задать секреты на уровне репозитория или организации. Дополнительные сведения см. в разделе «Управление секретами среды разработки для репозитория или организации».
Указание рекомендуемых секретов в конфигурации контейнера разработки
-
Вы можете настроить пространства кода, созданные для репозитория, добавив параметры в
devcontainer.json
файл. Если репозиторий еще не содержитdevcontainer.json
файл, его можно добавить. См. раздел "Добавление конфигурации контейнера разработки в репозиторий". -
Измените
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": { } }
"secrets": { "NAME_OF_SECRET_1": { "description": "This is the description of the secret.", "documentationUrl": "https://example.com/link/to/info" }, "NAME_OF_SECRET_2": { } }
-
Добавьте свойство внутри
secrets
каждого секрета, который вы хотите рекомендовать. Например, изменитеNAME_OF_SECRET_1
иNAME_OF_SECRET_2
в предыдущем примере кода на имена секретов, которые люди должны создавать в личных параметрах для Codespaces. -
При необходимости укажите описание каждого секрета и URL-адрес для получения дополнительных сведений об этом секрете.
Вы можете опустить
description
иdocumentationUrl
, как показаноNAME_OF_SECRET_2
в предыдущем примере кода. -
Укажите дополнительные секреты по мере необходимости.
-
Сохраните файл и зафиксируйте изменения в требуемой ветви репозитория.