CodeStarSourceConnection para Bitbucket Cloud GitHub, GitHub Enterprise Server, GitLab .com y acciones GitLab autogestionadas

Las acciones de origen para las conexiones son compatibles con. AWS CodeConnections CodeConnections permite crear y administrar conexiones entre AWS recursos y repositorios de terceros, como GitHub. Inicia una canalización cuando se realiza una nueva confirmación en un repositorio de código fuente de terceros. La acción de origen recupera los cambios de código cuando se ejecuta manualmente una canalización o cuando se envía un evento webhook desde el proveedor de origen.

Puedes configurar acciones en tu canalización para usar una configuración de Git que te permita iniciar tu canalización con activadores. Para configurar la configuración de los activadores de canalización para filtrar con activadores, consulta más información enFiltra los activadores en las solicitudes de inserción o extracción de código.

nota

Esta función no está disponible en las regiones Asia Pacífico (Hong Kong), Asia Pacífico (Hyderabad), Asia Pacífico (Yakarta), Asia Pacífico (Melbourne), Asia Pacífico (Osaka), África (Ciudad del Cabo), Oriente Medio (Bahréin), Oriente Medio (Emiratos Árabes Unidos), Europa (España), Europa (Zúrich), Israel (Tel Aviv) o AWS GovCloud (EE. UU. Oeste). Para hacer referencia a otras acciones disponibles, consulte Integraciones de productos y servicios con CodePipeline. Para ver consideraciones sobre esta acción en la región de Europa (Milán), consulte la nota que aparece en CodeStarSourceConnection para Bitbucket Cloud GitHub, GitHub Enterprise Server, GitLab .com y acciones GitLab autogestionadas.

Connections puede asociar tus AWS recursos a los siguientes repositorios de terceros:

• Bitbucket Cloud (mediante la opción de proveedor de Bitbucket en la CodePipeline consola o el Bitbucket proveedor en la CLI)

  nota

  Puede crear conexiones a un repositorio de Bitbucket Cloud. Los tipos de proveedores de Bitbucket instalados, como Bitbucket Server, no son compatibles.

• nota

  Si utiliza un espacio de trabajo de Bitbucket, debe tener acceso de administrador para crear la conexión.

• GitHub y GitHub Enterprise Cloud (mediante la opción de proveedor GitHub (versión 2) en la CodePipeline consola o el GitHub proveedor en la CLI)

  nota

  Si tu repositorio está en una GitHub organización, debes ser el propietario de la organización para crear la conexión. Si está utilizando un repositorio que no está en una organización, debe ser el propietario del repositorio.

• GitHub Enterprise Server (mediante la opción de proveedor de GitHub Enterprise Server en la CodePipeline consola o el GitHub Enterprise Server proveedor en la CLI)

• GitLab.com (mediante la opción GitLabde proveedor en la CodePipeline consola o el GitLab proveedor en la CLI)

  nota

  Puede crear conexiones a un repositorio en el que tenga la función de propietario y GitLab, a continuación, la conexión se puede utilizar con el repositorio con recursos como CodePipeline: En el caso de los repositorios en grupos, no es necesario que sea el propietario del grupo.

• Instalación autogestionada para GitLab (Enterprise Edition o Community Edition) (mediante la opción de proveedor GitLab autogestionado en la CodePipeline consola o el GitLabSelfManaged proveedor en la CLI)

nota

Cada conexión es compatible con todos los repositorios que tenga con ese proveedor. Solo tiene que crear una conexión nueva para cada tipo de proveedor.

Las conexiones permiten que su canalización detecte los cambios de origen a través de la aplicación de instalación del proveedor externo. Por ejemplo, los webhooks se utilizan para suscribirse a tipos de GitHub eventos y se pueden instalar en una organización, un repositorio o una aplicación. GitHub Tu conexión instala un webhook de repositorio en tu GitHub aplicación que se suscribe a GitHub eventos de tipo push.

Después de detectar un cambio de código, tiene las siguientes opciones para pasar el código a acciones posteriores:

• Predeterminado: al igual que otras acciones de CodePipeline código fuente existentes, CodeStarSourceConnection puedes generar un archivo ZIP con una copia superficial de tu confirmación.

• Full cone (Clonación completa): CodeStarSourceConnection también se puede configurar para generar una referencia URL al repositorio para acciones posteriores.

  Actualmente, la referencia a la URL de Git solo la pueden usar las CodeBuild acciones posteriores para clonar el repositorio y los metadatos de Git asociados. Si se intenta pasar una referencia a una URL de Git a una falta de CodeBuild acción, se produce un error.

CodePipeline te pide que añadas la aplicación de instalación de AWS Connector a tu cuenta de terceros al crear una conexión. Debe haber creado ya su cuenta y repositorio de proveedor externo para poder conectarse a través de la acción CodeStarSourceConnection.

nota

Para crear o asociar una política a su rol con los permisos necesarios para usar las conexiones de AWS CodeStar , consulte Referencia de permisos de conexiones. En función de cuándo se creó su función de CodePipeline servicio, es posible que necesite actualizar sus permisos para admitir AWS CodeStar las conexiones. Para ver instrucciones, consulte Agregar permisos al rol de servicio de CodePipeline.

nota

Para usar conexiones en Europa (Milán) Región de AWS, debes:

1. Instalar una aplicación específica de la región

2. Habilitar la región

Esta aplicación específica de la región está disponible en la región Europa (Milán). Se publica en el sitio del proveedor externo y es independiente de la aplicación existente que admite conexiones para otras regiones. Al instalar esta aplicación, autoriza a los proveedores externos a compartir sus datos con el servicio únicamente para esta región, y puede revocar los permisos en cualquier momento desinstalando la aplicación.

El servicio no procesará ni almacenará sus datos a menos que habilite la región. Al habilitar esta región, otorga a nuestro servicio permisos para procesar y almacenar sus datos.

Aunque la región no esté habilitada, los proveedores externos pueden compartir sus datos con nuestro servicio si la aplicación específica de la región permanece instalada, así que asegúrese de desinstalar la aplicación una vez que deshabilite la región. Para obtener más información, consulte Habilitar una región.

Tipo de acción

• Categoría: Source

• Propietario: AWS

• Proveedor: CodeStarSourceConnection

• Versión: 1

Parámetros de configuración

ConnectionArn

Obligatorio: sí

El ARN de conexión que se ha configurado y autenticado para el proveedor de código fuente.

FullRepositoryId

Obligatorio: sí

El propietario y el nombre del repositorio en el que se van a detectar los cambios de código fuente.

Ejemplo: some-user/my-repo

importante

Debe mantener las mayúsculas y minúsculas correctas para el FullRepositoryIdvalor. Por ejemplo, si tu nombre de usuario es some-user y el nombre del repositorio esMy-Repo, el valor recomendado FullRepositoryIdessome-user/My-Repo.

BranchName

Obligatorio: sí

El nombre de la ramificación donde se van a detectar los cambios de origen.

OutputArtifactFormat

Obligatorio: no

Especifica el formato del artefacto de salida. Puede ser CODEBUILD_CLONE_REF o CODE_ZIP. Si no se especifica, el valor predeterminado es CODE_ZIP.

importante

La CODEBUILD_CLONE_REF opción solo la pueden utilizar las acciones CodeBuild posteriores.

Si elige esta opción, tendrá que actualizar los permisos de su función de servicio de CodeBuild proyectos, tal y como se muestra en Añade CodeBuild GitClone permisos para las conexiones a Bitbucket, Enterprise Server o .com GitHub GitHub GitLab la siguiente. Para ver un tutorial que muestra cómo utilizar la opción Clonación completa, consulte Tutorial: Utilice un clon completo con una fuente de GitHub canalización.

DetectChanges

Obligatorio: no

Controla automáticamente el inicio de su canalización cuando se realiza una nueva confirmación en el repositorio y la rama configurados. Si no se especifica, el valor predeterminado es true y el campo no se muestra de forma predeterminada. Los valores válidos para este parámetro son:

• true: inicia CodePipeline automáticamente tu canalización con las nuevas confirmaciones.

• false: CodePipeline no inicia tu canalización con nuevas confirmaciones.

Artefactos de entrada

• Número de artefactos: 0

• Descripción: los artefactos de entrada no se aplican a este tipo de acción.

Artefactos de salida

• Número de artefactos: 1

• Descripción: los artefactos generados desde el repositorio son los artefactos de salida de la acción CodeStarSourceConnection. El ID de confirmación del código fuente se muestra CodePipeline como la revisión de origen de la ejecución de la canalización activada. Puede configurar el artefacto de salida de esta acción en:

  • Un archivo ZIP que incluye el contenido del repositorio configurado y la ramificación en la confirmación especificada como la revisión de código fuente para la ejecución de la canalización.

  • Un archivo JSON que contiene una referencia URL al repositorio para que las acciones posteriores puedan ejecutar comandos de Git directamente.

    importante

    Esta opción solo la pueden utilizar las acciones CodeBuild posteriores.

    Si elige esta opción, tendrá que actualizar los permisos de su función de servicio de CodeBuild proyectos, tal y como se muestra en Solución de problemas CodePipeline la siguiente. Para ver un tutorial que muestra cómo utilizar la opción Clonación completa, consulte Tutorial: Utilice un clon completo con una fuente de GitHub canalización.

Variables de salida

Cuando se configura, esta acción produce variables a las que se puede hacer referencia mediante la configuración de acción de una acción descendente en la canalización. Esta acción produce variables que se pueden ver como variables de salida, incluso si la acción no tiene un espacio de nombres. Configure una acción con un espacio de nombres para que esas variables estén disponibles para la configuración de las acciones posteriores.

Para obtener más información, consulte Variables.

AuthorDate

Fecha en la que se creó la confirmación, en formato de marca temporal.

BranchName

El nombre de la ramificación del repositorio donde se realizó el cambio de origen.

CommitId

El ID de confirmación de que desencadenó la ejecución de la canalización.

CommitMessage

El mensaje de descripción, si lo hay, asociado a la confirmación que desencadenó la ejecución de la canalización.

ConnectionArn

El ARN de conexión que se ha configurado y autenticado para el proveedor de código fuente.

FullRepositoryName

El nombre del repositorio de donde se realizó la confirmación que activó la canalización.

Declaración de acciones

En el siguiente ejemplo, el artefacto de salida se establece en el formato ZIP predeterminado de CODE_ZIP para la conexión con ARN arn:aws:codestar-connections:region:account-id:connection/connection-id.

YAML

Name: Source
Actions:
  - InputArtifacts: []
    ActionTypeId:
      Version: '1'
      Owner: AWS
      Category: Source
      Provider: CodeStarSourceConnection
    OutputArtifacts:
      - Name: SourceArtifact
    RunOrder: 1
    Configuration:
      ConnectionArn: "arn:aws:codestar-connections:region:account-id:connection/connection-id"
      FullRepositoryId: "some-user/my-repo"
      BranchName: "main"
      OutputArtifactFormat: "CODE_ZIP"
    Name: ApplicationSource

JSON

{
    "Name": "Source",
    "Actions": [
        {
            "InputArtifacts": [],
            "ActionTypeId": {
                "Version": "1",
                "Owner": "AWS",
                "Category": "Source",
                "Provider": "CodeStarSourceConnection"
            },
            "OutputArtifacts": [
                {
                    "Name": "SourceArtifact"
                }
            ],
            "RunOrder": 1,
            "Configuration": {
                "ConnectionArn": "arn:aws:codestar-connections:region:account-id:connection/connection-id",
                "FullRepositoryId": "some-user/my-repo",
                "BranchName": "main",
                "OutputArtifactFormat": "CODE_ZIP"
            },
            "Name": "ApplicationSource"
        }
    ]
},

Instalación de la aplicación de instalación y creación de una conexión

La primera vez que utilices la consola para añadir una nueva conexión a un repositorio de terceros, debes autorizar el CodePipeline acceso a tus repositorios. Elegirá y creará una aplicación de instalación que le ayude a conectarse a la cuenta en la que ha creado su repositorio de código de terceros.

Cuando utilice la plantilla AWS CLI o una AWS CloudFormation plantilla, debe proporcionar el ARN de conexión de una conexión que ya haya pasado por el protocolo de enlace de instalación. De lo contrario, la canalización no se activará.

nota

Para una acción de origen CodeStarSourceConnection, no es necesario configurar un webhook ni utilizar el sondeo de forma predeterminada. La acción de conexiones gestiona automáticamente la detección de cambio de origen.

Véase también

Los recursos relacionados siguientes pueden serle de ayuda cuando trabaje con esta acción.

• AWS::CodeStarConnections::Connection— La referencia AWS CloudFormation de plantilla del recurso AWS CodeStar Connections proporciona parámetros y ejemplos de conexiones en AWS CloudFormation plantillas.

• AWS CodeStarReferencia de la API de AWS CodeStar conexiones: la referencia de la API de conexiones proporciona información de referencia para las acciones de conexión disponibles.

• Para ver los pasos para crear una canalización con acciones de origen compatibles con las conexiones, consulte lo siguiente:

  • Para Bitbucket Cloud, use la opción Bitbucket en la consola o la acción CodestarSourceConnection en la CLI. Consulte Conexiones de Bitbucket Cloud.

  • Para GitHub GitHub Enterprise Cloud, utilice la opción de GitHubproveedor en la consola o la CodestarSourceConnection acción en la CLI. Consulte GitHub conexiones.

  • Para GitHub Enterprise Server, utilice la opción de proveedor de GitHub Enterprise Server en la consola o la CodestarSourceConnection acción en la CLI. Consulte GitHub Conexiones de Enterprise Server.

  • Para GitLab .com, utilice la opción de GitLabproveedor en la consola o la CodestarSourceConnection acción con el GitLab proveedor en la CLI. Consulte GitLabconexiones .com.

• Para ver un tutorial de introducción que crea una canalización con una fuente y una CodeBuild acción de Bitbucket, consulta Cómo empezar con las conexiones.

• Para ver un tutorial que te muestra cómo conectarte a un GitHub repositorio y cómo usar la opción de clonación completa con una CodeBuild acción posterior, consulta. Tutorial: Utilice un clon completo con una fuente de GitHub canalización