Especificación de secretos recomendados para un repositorio

Acerca de los secretos recomendados

Si un proyecto necesita que se configuren secretos específicos del usuario, puedes pedir a los usuarios que lo hagan cuando creen un codespace. Para ello, agrega una configuración a un archivo de configuración de contenedor de desarrollo para el repositorio.

Después de especificar secretos recomendados, si los usuarios aún no han creado esos secretos en su configuración personal para Codespaces, se les pedirá que lo hagan cuando usen el método de opciones avanzadas para crear un codespace. Esto se hace en GitHub al hacer clic en el botón Código , luego haciendo clic en la pestaña Codespaces y, a continuación, seleccionando y haciendo clic en Nuevo con opciones.

Los secretos recomendados se muestran en la parte inferior de la página.

Cada secreto recomendado se muestra de una de estas tres maneras:

• Si la persona no ha establecido el secreto recomendado en su configuración de Codespaces, se muestra un cuadro de entrada, lo que permite crear el secreto ahora. Si se han configurado, se muestra una descripción y un vínculo a más información. La escritura de un valor es opcional.
• Si la persona ya ha creado el secreto recomendado pero no lo ha asociado a este repositorio, puede activar una casilla para agregar esta asociación. Esto es opcional.
• Si la persona ya ha creado el secreto recomendado y lo ha asociado a este repositorio, se muestra una casilla preseleccionada.

Cuándo especificar secretos recomendados para un proyecto

Debes usar secretos recomendados para los secretos de entorno de desarrollo que debe proporcionar el usuario que crea el codespace, en lugar del propietario del repositorio u organización. Por ejemplo, si tienes un proyecto público y los usuarios deben proporcionar una clave de API personal para ejecutar la aplicación en el proyecto, puedes especificar un secreto recomendado para que se les pida a los usuarios que proporcionen la clave como valor del secreto cuando usen la página de opciones avanzadas para crear un codespace.

Como alternativa, para los secretos de entorno de desarrollo que el propietario del repositorio u organización pueden proporcionar, como las claves de API compartidas en un equipo, puedes establecer secretos en el nivel del repositorio u organización. Para obtener más información, vea «Administración de secretos del entorno de desarrollo para el repositorio o la organización».

Especificación de secretos recomendados en la configuración del contenedor de desarrollo

1. Puedes configurar los codespaces creados para el repositorio agregando configuraciones a un archivo devcontainer.json. Si el repositorio aún no contiene un archivo devcontainer.json, puedes agregar uno ahora. Consulte "Incorporación de una configuración de contenedor de desarrollo al repositorio".

2. Edita el archivo devcontainer.json, agregando la propiedad secrets en el nivel superior del archivo, dentro del objeto JSON envolvente. Por ejemplo:

   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. Agrega una propiedad dentro de secrets para cada secreto que desees recomendar. Por ejemplo, cambia NAME_OF_SECRET_1 y NAME_OF_SECRET_2, en el ejemplo de código anterior, por los nombres de los secretos que los usuarios deben crear en su configuración personal para Codespaces.

4. Opcionalmente, proporciona una descripción para cada secreto y una dirección URL para obtener más información sobre este secreto.

   Puedes omitir description y documentationUrl, como muestra NAME_OF_SECRET_2 en el ejemplo de código anterior.

5. Especifica secretos adicionales, según sea necesario.

6. Guarda el archivo y confirma tus cambios a la rama requerida del repositorio.

Información adicional

• "Creación de un codespace para un repositorio"