Skip to main content

Administrar secretos cifrados para tus codespaces

Puedes almacenar información sensible, como los tokens, a la cual quieras acceder en tus codespaces en forma de variables de ambiente.

Acerca de los secretos cifrados de GitHub Codespaces

Puedes agregar a tu cuenta personal los secretos cifrados que quieras utilizar en tus codespaces. Por ejemplo, puede que quieras almacenar y acceder a la siguiente información sensible en forma de un secreto cifrado.

Puedes elegir qué repositorios deben tener acceso a cada secreto. Posteriormente, puedes utilizar el secreto en cualquier codespace que crees para un repositorio que tenga acceso a él. Para compartir un secreto con un codespace creado a partir de una plantilla, deberás publicar el codespace en un repositorio de GitHub y, después, conceder a ese repositorio acceso al secreto.

Una vez que hayas creado un secreto, estará disponible cuando creas un codespace nuevo o cuando reinicias el codespace. Para utilizar un secreto que acabas de crear en un codespace actual, necesitarás detenerlo y reanudarlo. Para obtener más información sobre cómo detener el codespace, consulta "Uso de Visual Studio Code Command Palette en GitHub Codespaces".

Nombrar secretos

Las siguientes reglas aplican a los nombres secretos:

  • Los nombres de secretos solo pueden contener caracteres alfanuméricos ([a-z], [A-Z], [0-9]) o caracteres de subrayado (_). No se permiten espacios.

  • Los nombres de secreto no deben comenzar con el prefijo GITHUB_.

  • Los nombres secretos no deben comenzar con un número.

  • Los nombres de secreto no distinguen entre mayúsculas y minúsculas.

  • Los nombres secretos deben ser únicos en el nivel en el que se hayan creado. Por ejemplo, un secreto que se crea a nivel de repositorio debe tener un nombre único en este.

    Si existe un secreto con el mismo nombre en varios niveles, tiene preferencia el del nivel más bajo. Por ejemplo, si un secreto a nivel de organización tiene el mismo nombre que un secreto a nivel de repositorio, entonces el secreto a nivel de repositorio tomará precedencia.

Límites para los secretos

Puedes almacenar hasta 100 secretos para GitHub Codespaces.

Los secretos tienen un tamaño máximo de 48 KB.

Agregar un secreto

  1. En la esquina superior derecha de cualquier página, haga clic en la foto del perfil y, luego, en Settings (Configuración).

    Icono Settings (Parámetros) en la barra de usuario 1. En la sección "Código, planificación y automatización" de la barra lateral, haga clic en Codespaces.

  2. A la derecha de "Codespaces secrets", haga clic en New secret. Botón "New secret"

  3. Debajo de "Nombre", teclea un nombre para tu secreto. Cuadro de texto "Name" 1. Debajo de "Valor", teclea el valor de tu secreto. Cuadro de texto "Valor" 1. Selecciona el menú desplegable de "Acceso al repositorio" y luego da clic en aquél a cuyo secreto quieras acceder. Repite esto para cada repositorio del cual quieras tener acceso al secreto. Menú desplegable "Acceso al repositorio"

  4. Haga clic en Add Secret.

Editar un secreto

Puedes actualizar el valor de un secreto existente y puedes cambiar qué repositorios pueden acceder a un secreto.

  1. En la esquina superior derecha de cualquier página, haga clic en la foto del perfil y, luego, en Settings (Configuración).

    Icono Settings (Parámetros) en la barra de usuario 1. En la sección "Código, planificación y automatización" de la barra lateral, haga clic en Codespaces.

  2. En "Codespaces secrets", a la derecha del secreto que quiera editar, haga clic en Update. Botón "Update"

  3. En "Value", haga clic en enter a new value. vínculo "enter a new value" 1. Debajo de "Valor", teclea el valor de tu secreto. Cuadro de texto "Valor" 1. Selecciona el menú desplegable de "Acceso al repositorio" y luego da clic en aquél a cuyo secreto quieras acceder. Repite esto para cada repositorio del cual quieras tener acceso al secreto. Menú desplegable "Acceso al repositorio"

  4. Opcionalmente, para eliminar el acceso del secreto a un repositorio, deselecciona el repositorio. Casillas para eliminar el acceso a los repositorios

  5. Haga clic en Guardar cambios.

Borrar un secreto

  1. En la esquina superior derecha de cualquier página, haga clic en la foto del perfil y, luego, en Settings (Configuración).

    Icono Settings (Parámetros) en la barra de usuario 1. En la sección "Código, planificación y automatización" de la barra lateral, haga clic en Codespaces.

  2. En "Codespaces secrets", a la derecha del secreto que quiera eliminar, haga clic en Delete. Botón "Delete"

  3. Lea la advertencia y haga clic en Aceptar. Confirmación para eliminar un secreto

Uso de secretos

Un secreto se exporta como una variable de entorno a la sesión de terminal del usuario.

Representación del valor de un secreto exportado en el terminal

Puedes usar secretos en un codespace una vez que se compile y esté en ejecución. Por ejemplo, un secreto se puede usar:

  • Al iniciar una aplicación desde el terminal integrado o la sesión ssh.
  • Dentro de un script de ciclo de vida del contenedor de desarrollo que se ejecuta después de ejecutar el codespace. Para más información sobre los scripts de ciclo de vida del contenedor de desarrollo, consulta la documentación del sitio web de contenedores de desarrollo: Especificación.

Los secretos de codespace no se pueden usar:

  • Durante el tiempo de compilación del codespace (es decir, dentro de un Dockerfile o un punto de entrada personalizado).
  • Dentro de una característica de contenedor de desarrollo. Para más información, consulta la propiedad features en la especificación de contenedores de desarrollo en el sitio web de contenedores de desarrollo.

Información adicional