Variables de versión clásica y artefactos

Azure Pipelines | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018 - TFS 2015

A medida que crea las tareas para implementar la aplicación en cada fase de los procesos de CI/CD de DevOps, las variables le ayudarán a:

• Defina una canalización de implementación más genérica una vez y personalízala fácilmente para cada fase. Por ejemplo, se puede usar una variable para representar la cadena de conexión para la implementación web y el valor de esta variable se puede cambiar de una fase a otra. Se trata de variables personalizadas.

• Use información sobre el contexto de la versión,la fase , los artefactos o el agente concretosen los que se ejecuta la canalización de implementación. Por ejemplo, el script puede necesitar acceso a la ubicación de la compilación para descargarla o al directorio de trabajo del agente para crear archivos temporales. Estas son las variables predeterminadas.

Variables predeterminadas

La información sobre el contexto de ejecución está disponible para las tareas en ejecución a través de variables predeterminadas. Las tareas y los scripts pueden usar estas variables para buscar información sobre el sistema, la versión, la fase o el agente en los que se ejecutan. A excepción de System.Debug,estas variables son de solo lectura y el sistema establece automáticamente sus valores. Algunas de las variables más importantes se describen en las tablas siguientes. Para ver la lista completa, vea Ver los valores actuales de todas las variables.

Sistema

Release

Fase de versión

Agente

Artefacto general

Para cada artefacto al que se hace referencia en una versión, puede usar las siguientes variables de artefacto. No todas las variables son significativas para cada tipo de artefacto. En la tabla siguiente se enumeran las variables de artefacto predeterminadas y se proporcionan ejemplos de los valores que tienen en función del tipo de artefacto. Si un ejemplo está vacío, implica que la variable no se rellena para ese tipo de artefacto.

Reemplace el {alias} marcador de posición por el valor especificado para el alias del {alias} o por el valor predeterminado generado para la canalización de versión.

Consulte también Alias de origen de artefacto.

Artefacto principal

Uno de los artefactos se designa como artefacto principal en una canalización de versión. Para el artefacto principal designado, Azure Pipelines rellena las variables siguientes.

Uso de variables predeterminadas

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

Puede usar directamente una variable predeterminada como entrada para una tarea. Por ejemplo, para pasar para el origen del artefacto Release.Artifacts.{Artifact alias}.DefinitionName cuyo alias Release.Artifacts.{Artifact alias}.DefinitionName a una tarea, usaría $(Release.Artifacts.ASPNET4.CI.DefinitionName) .

Para usar una variable predeterminada en el script, primero debe reemplazar en los . nombres de variable predeterminados por _ . Por ejemplo, para imprimir el valor de la variable de artefacto para el origen del artefacto cuyo alias ASPNET4.CI en un Release.Artifacts.{Artifact alias}.DefinitionName script de PowerShell, Release.Artifacts.{Artifact alias}.DefinitionName usaría $env:RELEASE_ARTIFACTS_ASPNET4_CI_DEFINITIONNAME .

Tenga en cuenta que el nombre original del alias de origen del artefacto, ASPNET4.CI , se reemplaza por ASPNET4_CI .

Ver los valores actuales de todas las variables

1. Abra la vista de canalizaciones del resumen de la versión y elija la fase que le interesa. En la lista de pasos, elija Inicializar trabajo.

   

2. Se abrirá el registro de este paso. Desplácese hacia abajo para ver los valores usados por el agente para este trabajo.

   

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

Muestre información adicional a medida que se ejecuta una versión y en los archivos de registro mediante la ejecución de toda la versión, o simplemente las tareas de una fase de versión individual, en modo de depuración. Esto puede ayudarle a resolver problemas y errores.

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

• Para iniciar el modo de depuración de una sola fase, abra el cuadro de diálogo Configurar fase en el menú contextual de la fase y agregue una variable denominada con el valor a la pestaña truetrue

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

Variables personalizadas

Las variables personalizadas se pueden definir en varios ámbitos.

• Comparta valores entre todas las definiciones de un proyecto mediante grupos de variables. Elija un grupo de variables cuando necesite usar los mismos valores en todas las definiciones, fases y tareas de un proyecto, y quiera poder cambiar los valores en un único lugar. Los grupos de variables se definen y administran en la pestaña Biblioteca.

• Comparta valores en todas las fases mediante variables de canalización de versión. Elija una variable de canalización de versión cuando necesite usar el mismo valor en todas las fases y tareas de la canalización de versión y desee poder cambiar el valor en un solo lugar. Estas variables se definen y administran en la pestaña Variables de una canalización de versión. En la página Variables de canalización, abra la lista desplegable Ámbito y seleccione "Versión". De forma predeterminada, cuando se agrega una variable, se establece en Ámbito de versión.

• Comparta valores entre todas las tareas dentro de una fase específica mediante variables de fase. Use una variable de nivel de fase para valores que varían de una fase a otra (y son iguales para todas las tareas de una fase). Estas variables se definen y administran en la pestaña Variables de una canalización de versión. En la página Variables de canalización, abra la lista desplegable Ámbito y seleccione la fase necesaria. Al agregar una variable, establezca ámbito en el entorno adecuado.

El uso de variables personalizadas en el proyecto, la canalización de versión y el ámbito de fase le ayuda a:

• Evite la duplicación de valores, lo que facilita la actualización de todas las repeticiones como una operación.

• Almacene valores confidenciales de forma que los usuarios de las canalizaciones de versión no puedan verlos ni cambiarse. Designe una propiedad de configuración para que sea una variable segura (secreta) seleccionando el icono (candado) 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 guardarse. Durante una implementación, el Azure Pipelines de versión de seguridad descifra estos valores cuando las tareas hacen referencia a ellos y los pasa al agente a través de un canal HTTPS seguro.

Uso de variables personalizadas

Para usar variables personalizadas en las tareas de compilación y versión, basta con incluir el nombre de la variable entre paréntesis y precederlo por un $ carácter. Por ejemplo, si tiene una variable denominada adminUserName, puede insertar el valor actual de esa variable en un parámetro de una tarea como .

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

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

Por ejemplo, Agent.WorkFolder se convierte en AGENT_WORKFOLDER. En Windows, se accede a este como %AGENT_WORKFOLDER% o $env:AGENT_WORKFOLDER . En Linux y macOS, se usa $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)"

#!/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)