Uso de variables en canalizaciones de versión clásicas

Servicios de Azure DevOps | Azure DevOps Server | Azure DevOps Server 2022

El uso de variables en canalizaciones de versión clásicas son una manera cómoda de intercambiar y transportar datos a lo largo de la canalización. Cada variable se almacena como una cadena y su valor puede cambiar entre ejecuciones de canalización.

Al configurar tareas para implementar su aplicación en cada etapa de la tubería de liberación clásica, las variables le pueden ayudar a:

• Simplificar la personalización: defina una canalización de implementación genérica una vez y adáptela fácilmente para diferentes fases. Por ejemplo, use una variable para representar la cadena de conexión de una implementación web, ajustando su valor según sea necesario para cada fase. Estas variables se conocen como variables personalizadas.

• Aprovechar información contextual: acceda a los detalles sobre el contexto de versión, como una fase, un artefacto o el agente que ejecuta la implementación. Por ejemplo, los scripts pueden requerir la ubicación de compilación para su descarga o el directorio de trabajo del agente para crear archivos temporales. Estas variables se conocen como variables predeterminadas.

Variables predeterminadas

Las variables predeterminadas proporcionan información esencial sobre el contexto de ejecución para las tareas y scripts en ejecución. Estas variables proporcionan acceso a detalles sobre el sistema, la versión, la fase o el agente en los que se ejecutan.

Con la excepción de System.Debug, las variables predeterminadas son de solo lectura y el sistema establece automáticamente sus valores.

Algunas de las variables más significativas se describen en las tablas siguientes. Para ver la lista completa, consulte Ver los valores actuales de todas las variables.

Variables del sistema

Variables de lanzamiento

Variables de la fase de publicación

Variables del agente

Liberar variables de artefactos

Para cada artefacto al que haga referencia en una versión, use las siguientes variables de artefacto. Tenga en cuenta que no todas las variables se aplican a todos los tipos de artefacto. En la tabla siguiente se enumeran las variables de artefacto predeterminadas y se proporcionan ejemplos de sus valores en función del tipo de artefacto. Si un ejemplo está vacío, indica que la variable no es aplicable a ese tipo de artefacto.

Reemplaza el {alias} marcador de posición por el valor que especificas para el "alias" de fuente del artefacto o por el valor predeterminado que se genera para la canalización de lanzamiento.

Variables de artefacto principal

En canalizaciones de versión clásicas, si usa varios artefactos, puede designar un artefacto como el artefacto principal. Después, Azure Pipelines rellena las siguientes variables para el artefacto principal designado.

Usar variables predeterminadas

Puede usar las variables predeterminadas de dos maneras: como parámetros de tareas en una canalización de publicación o en sus scripts.

Use una variable predeterminada directamente como entrada para una tarea. Por ejemplo, para pasar Release.Artifacts.{Artifact alias}.DefinitionName como argumento a una tarea de PowerShell para un artefacto con ASPNET4.CI como alias, use $(Release.Artifacts.ASPNET4.CI.DefinitionName).

Para usar una variable predeterminada en el script, reemplace en . los nombres de variable predeterminados por _. Por ejemplo, para imprimir el valor de Release.Artifacts.{Artifact alias}.DefinitionName para un artefacto con ASPNET4.CI como alias en un script de PowerShell, use $env:RELEASE_ARTIFACTS_ASPNET4_CI_DEFINITIONNAME. El alias original, ASPNET4.CI, se reemplaza por ASPNET4_CI.

Variables personalizadas

Puede definir variables personalizadas en distintos ámbitos.

• Grupos de variables: utilice grupos de variables para compartir valores en todas las definiciones de un proyecto. Este enfoque es útil cuando desea usar los mismos valores en las definiciones, las fases y las tareas de un proyecto y administrarlos desde una sola ubicación. Defina y administre grupos de variables en la Canalizaciones>Biblioteca.

• Variables de canalización de versiones: Use variables de canalización de versiones para compartir valores entre todas las fases de una canalización de versiones. Este enfoque es ideal para escenarios en los que se necesita un valor coherente entre fases y tareas, con la capacidad de actualizarlo desde una sola ubicación. Defina y administre estas variables en la pestaña Variables de la canalización de lanzamiento. En la página Variables de canalización, establezca la lista desplegable Ámbito en Versión al agregar una variable.

• Variables de fase: Use variables de fase para compartir valores en una fase específica de una canalización de versiones. Este enfoque es útil para los valores que difieren de la fase a la fase, pero son coherentes en todas las tareas de una fase. Defina y administre estas variables en la pestaña Variables de la canalización de lanzamiento. En la página Variables de la canalización, seleccione el entorno adecuado en la lista desplegable Ámbito al añadir una variable.

Mediante el uso de variables personalizadas en el proyecto, el flujo de versiones y los niveles de etapas, puede hacer lo siguiente:

• Evitar duplicar valores, lo que facilita actualizar todas las apariciones con un único cambio.

• Proteger los valores confidenciales evitando que los usuarios los vean o modifiquen. Para marcar una variable como segura (secreto), seleccione el icono situado junto a la variable.

  Importante

  Los valores de las variables ocultas (secreto) se almacenan de forma segura en el servidor y los usuarios no pueden verlos después de guardarlos. Durante la implementación, Azure Pipelines descifra estos valores cuando las tareas las hacen referencia y las pasa al agente a través de un canal HTTPS seguro.

Uso de variables personalizadas

Para usar variables personalizadas en las tareas, incluya el nombre de la variable entre paréntesis y precédalo con un carácter $. Por ejemplo, si tiene una variable denominada adminUserName, inserte su valor actual en una tarea como $(adminUserName).

Definición y modificación de las variables en un script

Para definir o modificar una variable a partir de un script, use el comando de registro task.setvariable. El valor de variable actualizado tiene como ámbito el trabajo que se ejecuta y no se mantiene entre trabajos o fases. Tenga en cuenta que los nombres de variable se transforman en mayúsculas, con "." y " " reemplazados por "_".

Por ejemplo, Agent.WorkFolder se convierte en AGENT_WORKFOLDER.

• En Windows, puede acceder a esta variable como %AGENT_WORKFOLDER% o $env:AGENT_WORKFOLDER.
• En Linux y macOS, use $AGENT_WORKFOLDER.

@echo ##vso[task.setvariable variable=sauce]crushed tomatoes
@echo ##vso[task.setvariable variable=secret.Sauce;issecret=true]crushed tomatoes with garlic

"$(sauce)" "$(secret.Sauce)"

@echo off
set sauceArgument=%~1
set secretSauceArgument=%~2
@echo No problem reading %sauceArgument% or %SAUCE%
@echo But I cannot read %SECRET_SAUCE%
@echo But I can read %secretSauceArgument% (but the log is redacted so I do not spoil the secret)

Write-Host "##vso[task.setvariable variable=sauce]crushed tomatoes"
Write-Host "##vso[task.setvariable variable=secret.Sauce;issecret=true]crushed tomatoes with
            garlic"

-sauceArgument "$(sauce)" -secretSauceArgument "$(secret.Sauce)"

Param(
   [string]$sauceArgument,
   [string]$secretSauceArgument
)
Write-Host No problem reading $env:SAUCE or $sauceArgument
Write-Host But I cannot read $env:SECRET_SAUCE
Write-Host But I can read $secretSauceArgument "(but the log is redacted so I do not spoil the secret)"

- pwsh: |
      Write-Host No problem reading $(sauce)
      Write-Host But I cannot read $env:SECRET_SAUCE
      Write-Host But I can read $(secret.Sauce) "(but the log is redacted so I do not spoil the secret)"

#!/bin/bash
echo "##vso[task.setvariable variable=sauce]crushed tomatoes"
echo "##vso[task.setvariable variable=secret.Sauce;issecret=true]crushed tomatoes with garlic"

"$(sauce)" "$(secret.Sauce)"

#!/bin/bash
echo "No problem reading $SAUCE"
echo "But I cannot read $SECRET_SAUCE"

Salida de la consola al leer las variables:

No problem reading crushed tomatoes or crushed tomatoes
But I cannot read 
But I can read ******** (but the log is redacted so I do not spoil the secret)

Ver los valores actuales de todas las variables

1. Seleccione Pipelines>Versiones y, a continuación, seleccione la canalización de versiones.

2. Abra la vista de resumen de su versión y seleccione la etapa que le interese. En la lista de pasos, elija Inicializar trabajo.

   

3. Este paso abre los registros. Desplácese hacia abajo para ver los valores que usa el agente para este trabajo.

   

Ejecución de una versión en modo de depuración

La ejecución de una versión en modo de depuración puede ayudarle a diagnosticar y resolver problemas mostrando información adicional durante la ejecución de la versión. Puede activar el modo de depuración para toda la versión o solo para las tareas de una fase de versión específica.

• Para activar el modo de depuración para toda la versión, agregue una variable denominada System.Debug con el valor true a la pestaña Variables de la canalización de versión.

• Para activar el modo de depuración para una fase específica, abra el cuadro de diálogo Configurar fase desde el menú contextual de la fase y agregue una variable denominada System.Debug con el valor true a la pestaña Variables .

• Como alternativa, cree un grupo de variables que contenga una variable denominada System.Debug con el valor true y vincule este grupo de variables a la canalización de versión.

Utiliza IA para diseñar, validar y solucionar problemas con variables de versión

Las siguientes indicaciones de ejemplo para Copilot Chat le ayudan a comprender el alcance y la precedencia de las variables, diseñar una estrategia de variables fácil de mantener, validar el uso actual y solucionar problemas de resolución de variables cuando sea necesario. Copie y pegue estas indicaciones en Copilot Chat y reemplace los marcadores de posición por los nombres de fase, tarea y variable.

Copilot funciona con IA, por lo que es posible que se produzcan sorpresas y errores. Para obtener más información, consulte las preguntas frecuentes sobre el uso general de Copilot.

Contenido relacionado

• Orígenes de artefactos en canalizaciones de versión clásica

• Implementación de artefactos de solicitud de incorporación de cambios

• Uso de variables en un grupo de variables