Uso de variables definidas por el usuario

Las variables definidas por el usuario son pares clave-valor que usted define. Existen dos tipos:

• Variables de texto simple o simplemente variables: son pares clave-valor que se definen en texto sin formato en el archivo de definición del flujo de trabajo.

• Secretos: son pares clave-valor que se definen en una página de secretos independiente de la consola de Amazon CodeCatalyst . La clave (nombre) es una etiqueta pública y el valor contiene la información que deseas mantener privada. Solo debe especificar la clave en el archivo de definición del flujo de trabajo. Utilice secretos en lugar de contraseñas y otra información confidencial en el archivo de definición del flujo de trabajo.

nota

Por motivos de brevedad, en esta guía se utiliza el término variable para referirse a una variable de texto sin formato.

Definir una variable

Puede definir las variables de dos maneras:

• En la Inputs sección de una acción de flujo de trabajo, consulte Para definir una variable en la sección «Entradas»

• En la Steps sección de una acción de flujo de trabajo, consulte Para definir una variable en la sección «Pasos»

  nota

  El Steps método solo funciona con las acciones de CodeCatalyst compilación, prueba y GitHub acciones, ya que son las únicas acciones que incluyen una Steps sección.

Para ver ejemplos, consulte Ejemplos de variables definidas por el usuario.

Visual

Para definir una variable en la sección «Entradas» (editor visual)

1. Abra 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. Elija Visual.

7. En el diagrama de flujo de trabajo, elija la acción en la que desee establecer la variable.

8. Elija Entradas.

9. En Variables (opcional), elija Añadir variable y, a continuación, haga lo siguiente:

   Especifique una secuencia de pares de nombre/valor que defina las variables de entrada que desea poner a disposición de la acción. Los nombres de las variables se limitan a caracteres alfanuméricos (a-z, A-Z, 0-9), guiones (-) y guiones bajos (_). No se permiten espacios. No puede usar comillas para habilitar los caracteres especiales y los espacios en los nombres de las variables.

   Para obtener más información sobre las variables, incluidos ejemplos, consulteConfiguración y uso de variables en un flujo de trabajo.

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

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

YAML

Para definir una variable en la sección «Entradas» (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 acción de flujo de trabajo, añade un código similar al siguiente:

   action-name:
     Inputs:
       Variables:
         - Name: variable-name
           Value: variable-value

   Para obtener más ejemplos, consulte Ejemplos de variables definidas por el usuario. Para obtener más información, consulta la Definición de flujo de trabajo YAML sección para tu 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.

Visual

Para definir una variable en la sección «Pasos» (editor visual)

1. Abra 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. Elija Visual.

7. En el diagrama de flujo de trabajo, elija la acción en la que desee establecer la variable.

8. Elija Configuration (Configuración).

9. En los comandos de Shell o en GitHublas acciones (YAML), las que estén disponibles, defina una variable en la acciónSteps, de forma explícita o implícita.

   • Para definir la variable de forma explícita, inclúyela en un comando bash directamente en la sección. Steps

   • Para definir una variable de forma implícita, especifícala en un archivo al que se haga referencia en la sección de Steps la acción.

     Para ver ejemplos, consulte Ejemplos de variables definidas por el usuario. Para obtener más información, consulta la sección Definición de flujo de trabajo YAML correspondiente a la acción.

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

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

YAML

Para definir una variable en la sección «Pasos» (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 acción de flujo de trabajo, defina una variable en la Steps sección de la acción, de forma explícita o implícita.

   • Para definir la variable de forma explícita, inclúyela en un comando bash directamente en la Steps sección.

   • Para definir una variable de forma implícita, especifícala en un archivo al que se haga referencia en la sección de Steps la acción.

     Para ver ejemplos, consulte Ejemplos de variables definidas por el usuario. Para obtener más información, consulta la sección Definición de flujo de trabajo YAML correspondiente a la 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.

Definir un secreto

El secreto se define en la página de secretos de la CodeCatalyst consola. Para obtener más información, consulte Configuración y uso de secretos en un flujo de trabajo.

Por ejemplo, puedes definir un secreto con el siguiente aspecto:

• Nombre (clave): my-password

• Valor: ^*H3#!b9

Una vez definido el secreto, puede especificar la clave del secreto (my-password) en el archivo de definición del flujo de trabajo. Para ver un ejemplo práctico, consulte Ejemplo: hacer referencia a un secreto.

Exportar una variable para que otras acciones puedan utilizarla

Siga las instrucciones siguientes para exportar una variable de una acción para poder hacer referencia a ella en otras acciones.

Antes de exportar una variable, tenga en cuenta lo siguiente:

• Si solo necesitas hacer referencia a la variable dentro de la acción en la que está definida, no necesitas exportarla.

• No todas las acciones admiten la exportación de variables. Para determinar si la acción admite esta función, siga las instrucciones del editor visual que aparecen a continuación y compruebe si la acción incluye un botón de variables en la pestaña Salidas. En caso afirmativo, se admite la exportación de variables.

• Para exportar una variable de una GitHub acción, consulteExportación GitHub de un parámetro de salida para que otras acciones puedan usarlo.

Requisito previo

Asegúrese de haber definido la variable que desea exportar. Para obtener más información, consulte Definir una variable.

Visual

Para exportar una variable (editor visual)

1. Abra 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. Elija Visual.

7. En el diagrama de flujo de trabajo, elija la acción desde la que desee exportar la variable.

8. Elija Salidas.

9. En Variables: opcional, elija Añadir variable y, a continuación, haga lo siguiente:

   Especifique el nombre de la variable que desee que se exporte la acción. Esta variable ya debe estar definida en la Steps sección Inputs o de la misma acción.

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

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

YAML

Para exportar una variable (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 la acción desde la que desee exportar la variable, añada un código similar al siguiente:

   action-name:
     Outputs:
       Variables:
         - Name: variable-name

   Para obtener más ejemplos, consulte Ejemplos de variables definidas por el usuario.

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.

Hacer referencia a una variable en la acción que la define

Siga las instrucciones siguientes para hacer referencia a una variable en la acción que la define.

nota

Para hacer referencia a una variable generada por una GitHub acción, consulteHacer referencia a un parámetro GitHub de salida.

Requisito previo

Asegúrese de haber definido la variable a la que desea hacer referencia. Para obtener más información, consulte Definir una variable.

Visual

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

YAML

Para hacer referencia a una variable en la acción que la define

1. Abra 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 la CodeCatalyst acción que define la variable a la que quieres hacer referencia, añade la variable con la siguiente sintaxis de bash:

   $variable-name

   Por ejemplo:

   MyAction:
       Configuration:
         Steps:
           - Run: $variable-name

   Para obtener más ejemplos, consulte Ejemplos de variables definidas por el usuario. Para obtener más información, consulte la información de referencia de su acción en. Definición de flujo de trabajo YAML

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.

Hacer referencia a una salida variable mediante otra acción

Utilice las siguientes instrucciones para hacer referencia a las variables generadas por otras acciones.

nota

Para hacer referencia a la salida de una variable de una GitHub acción, consulteHacer referencia a un parámetro GitHub de salida.

Requisito previo

Asegúrese de haber exportado la variable a la que desea hacer referencia. Para obtener más información, consulte Exportar una variable para que otras acciones puedan utilizarla.

Visual

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

YAML

Para hacer referencia a la salida de una variable mediante otra acción (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 la CodeCatalyst acción, añade una referencia a la variable con la siguiente sintaxis:

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

   Sustituir:

   • action-group-namepor el nombre del grupo de acciones que contiene la acción que genera la variable.

     nota

     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 con el nombre de la acción que genera la variable.

   • nombre-variable con el nombre de la variable.

   Por ejemplo:

   MySecondAction:
       Configuration:
         Steps:
           - Run: ${MyFirstAction.TIMESTAMP}

   Para obtener más ejemplos, consulte Ejemplos de variables definidas por el usuario. 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.

Hacer referencia a un secreto

Para obtener instrucciones sobre cómo hacer referencia a un secreto en el archivo de definición del flujo de trabajo, consulte. Usar un secreto

Para ver un ejemplo, consulte Ejemplo: hacer referencia a un secreto.

Ejemplos de variables definidas por el usuario

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

Ejemplos

• Ejemplo: definir una variable mediante la propiedad Inputs
• Ejemplo: definir una variable mediante la propiedad Steps
• Ejemplo: exportar una variable mediante la propiedad Outputs
• Ejemplo: hacer referencia a una variable definida en la misma acción
• Ejemplo: hacer referencia a una variable definida en otra acción
• Ejemplo: hacer referencia a un secreto

Ejemplo: definir una variable mediante la propiedad Inputs

El siguiente ejemplo muestra cómo definir dos variables VAR1 yVAR2, en una Inputs sección.

Actions:
  Build:
    Identifier: aws/build@v1
    Inputs:
      Variables:
      - Name: VAR1
        Value: "My variable 1"
      - Name: VAR2
        Value: "My variable 2"

Ejemplo: definir una variable mediante la propiedad Steps

El siguiente ejemplo muestra cómo definir una DATE variable en la Steps sección de forma explícita.

Actions:
  Build:
    Identifier: aws/build@v1
    Configuration:    
      Steps:
        - Run: DATE=$(date +%m-%d-%y)

Ejemplo: exportar una variable mediante la propiedad Outputs

El siguiente ejemplo muestra cómo definir dos variables REPOSITORY-URI y TIMESTAMP exportarlas mediante la Outputs sección.

Actions:
  Build:
    Identifier: aws/build@v1
    Inputs:
      Variables:
        - Name: REPOSITORY-URI
          Value: 111122223333.dkr.ecr.us-east-2.amazonaws.com/codecatalyst-ecs-image-repo
    Configuration:
      Steps:
        - Run: TIMESTAMP=$(date +%m-%d-%y-%H-%m-%s) 
    Outputs:
      Variables:
        - REPOSITORY-URI
        - TIMESTAMP

Ejemplo: hacer referencia a una variable definida en la misma acción

En el siguiente ejemplo, se muestra cómo especificar una VAR1 variable en la misma acción yMyBuildAction, a continuación, hacer referencia a ella en la misma acción mediante$VAR1.

Actions:
  MyBuildAction:
    Identifier: aws/build@v1
    Inputs:
      Variables:
        - Name: VAR1
          Value: my-value
    Configuration:
      Steps:
        - Run: $VAR1

Ejemplo: hacer referencia a una variable definida en otra acción

El siguiente ejemplo muestra cómo especificar una TIMESTAMP variable enBuildActionA, exportarla mediante la Outputs propiedad y, a continuación, hacer referencia a ella al BuildActionB ${BuildActionA.TIMESTAMP} utilizarla.

Actions:
  BuildActionA:
    Identifier: aws/build@v1
    Configuration:    
      Steps:
        - Run: TIMESTAMP=$(date +%m-%d-%y-%H-%m-%s) 
    Outputs:
      Variables:
        - TIMESTAMP
  BuildActionB:
    Identifier: aws/build@v1
    Configuration:
      Steps:
        - Run: docker build -t my-ecr-repo/image-repo:latest .      
        - Run: docker tag my-ecr-repo/image-repo:${BuildActionA.TIMESTAMP}
        
        # Specifying just '$TIMESTAMP' here will not work 
        # because TIMESTAMP is not a variable 
        # in the BuildActionB action.

Ejemplo: hacer referencia a un secreto

El siguiente ejemplo muestra cómo hacer referencia a un my-password secreto. my-passwordEs la clave del secreto. La clave de este secreto y el valor de la contraseña correspondiente deben especificarse en la página de secretos de la CodeCatalyst consola antes de utilizarlos en el archivo de definición del flujo de trabajo. Para obtener más información, consulte Configuración y uso de secretos en un flujo de trabajo.

Actions:
  BuildActionA:
    Identifier: aws/build@v1
    Configuration:    
      Steps:
        - Run: curl -u LiJuan:${Secrets.my-password} https://example.com