Uso de variables predefinidas

Las variables predefinidas son pares clave-valor que un flujo de trabajo emite automáticamente y que están disponibles para su uso en las acciones del flujo de trabajo.

Puede utilizar variables predefinidas en cualquier acción del flujo de trabajo.

Hacer referencia a una variable predefinida

Utilice las siguientes instrucciones para hacer referencia a una variable predefinida.

Requisito previo

Determine el nombre de la variable predefinida a la que desea hacer referencia, por ejemploCommitId. Para obtener más información, consulte Determinar qué variables predefinidas emite tu flujo de trabajo.

Visual

No disponible. Selecciona YAML para ver las instrucciones de YAML.

YAML

Para hacer referencia a una variable predefinida (editor YAML)

1. Abre la CodeCatalyst consola en https://codecatalyst.aws/.

2. Elija el proyecto.

3. En el panel de navegación, elija CI/CD y, a continuación, elija Flujos de trabajo.

4. Elija el nombre de su flujo de trabajo. Puede filtrar por el nombre del repositorio o la rama de origen donde está definido el flujo de trabajo, o bien filtrar por el nombre del flujo de trabajo.

5. Elija Editar.

6. Elige YAML.

7. En una CodeCatalyst acción, añada la referencia de variable predefinida mediante la siguiente sintaxis:

   ${action-group-name.action-name-or-WorkflowSource.variable-name}

   Sustituir:

   • action-group-namepor el nombre del grupo de acciones.

     nota

     Se puede omitir action-group-namesi no hay ningún grupo de acciones o si la variable es producida por una acción del mismo grupo de acciones.

   • action-name-or- WorkflowSource con:

     El nombre de la acción que genera la variable.

     o

     WorkflowSource, si la variable es la CommitId variable BranchName o.

   • nombre de la variable con el nombre de la variable.

   Por ejemplo:

   MySecondAction:
       Configuration:
         Steps:
           - Run: echo ${MyFirstECSAction.cluster}

   Otro ejemplo.

   MySecondAction:
       Configuration:
         Steps:
           - Run: echo ${WorkflowSource.CommitId}

   Para obtener más ejemplos, consulte Ejemplos de variables predefinidas. Para obtener más información, consulte la sección Definición de flujo de trabajo YAML para su acción.

8. (Opcional) Selecciona Validar para validar el código YAML del flujo de trabajo antes de confirmarlo.

9. Selecciona Confirmar, introduce un mensaje de confirmación y vuelve a seleccionar Confirmar.

Determinar qué variables predefinidas emite tu flujo de trabajo

Puede determinar qué variables predefinidas emite su flujo de trabajo de dos maneras:

• Ejecute el flujo de trabajo una vez. Una vez finalizada la ejecución, las variables emitidas por el flujo de trabajo se muestran en la pestaña Variables de la página de detalles de la ejecución. Para obtener más información, consulte Ver el estado y los detalles de la ejecución del flujo de trabajo.

• Consulte el Lista de variables predefinidas. Esta referencia muestra el nombre de la variable (clave) y el valor de cada variable predefinida.

nota

El tamaño total máximo de las variables de un flujo de trabajo aparece enCuotas para flujos de trabajo. Si el tamaño total supera el máximo, es posible que se produzca un error en la acción que se lleve a cabo una vez alcanzado el máximo.

Ejemplos de variables predefinidas

Los siguientes ejemplos muestran cómo hacer referencia a variables predefinidas en el archivo de definición del flujo de trabajo.

Ejemplos

• Ejemplo: hacer referencia a la variable predefinida CommitId «»
• Ejemplo: hacer referencia a la variable predefinida BranchName «»

Ejemplo: hacer referencia a la variable predefinida CommitId «»

El siguiente ejemplo muestra cómo hacer referencia a la variable CommitId predefinida en la MyBuildAction acción. La CommitId variable se genera automáticamente mediante CodeCatalyst.

Aunque en el ejemplo se muestra la variable que se utiliza en la acción de creación, se puede utilizar CommitId en cualquier acción.

MyBuildAction:
    Identifier: aws/build@v1
    Inputs:
      Sources:
        - WorkflowSource
    Configuration:
      Steps:
      #Build Docker image and tag it with a commit ID
        - Run: docker build -t image-repo/my-docker-image:latest .
        - Run: docker tag image-repo/my-docker-image:${WorkflowSource.CommitId}

Ejemplo: hacer referencia a la variable predefinida BranchName «»

El siguiente ejemplo muestra cómo hacer referencia a la variable BranchName predefinida en la CDKDeploy acción. La BranchName variable se genera automáticamente mediante CodeCatalyst.

Aunque en el ejemplo se muestra la variable que se utiliza en la acción de AWS CDK despliegue, se puede utilizar BranchName en cualquier acción.

CDKDeploy:
    Identifier: aws/cdk-deploy@v1
    Inputs:
      Sources:
        - WorkflowSource
    Configuration:
      StackName: app-stack-${WorkflowSource.BranchName}