Ejemplo: publicar archivos en Amazon S3 - Amazon CodeCatalyst

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

Ejemplo: publicar archivos en Amazon S3

El siguiente flujo de trabajo de ejemplo incluye la acción de publicación de Amazon S3, junto con una acción de compilación. El flujo de trabajo crea un sitio web de documentación estática y, a continuación, lo publica en Amazon S3, donde está alojado. El flujo de trabajo consta de los siguientes componentes básicos que se ejecutan secuencialmente:

  • Un disparador: este activador inicia la ejecución automática del flujo de trabajo al introducir un cambio en el repositorio de origen. Para obtener más información acerca de los disparadores, consulte Iniciar un flujo de trabajo, ejecutarlo automáticamente mediante activadores.

  • Una acción de compilación (BuildDocs): al activarla, la acción crea un sitio web de documentación estática (mkdocs build) y añade los HTML archivos asociados y los metadatos auxiliares a un artefacto llamadoMyDocsSite. Para obtener más información sobre la acción de creación, consulteConstruir con flujos de trabajo.

  • Una acción de publicación de Amazon S3 (PublishToS3): al finalizar la acción de compilación, esta acción copia el sitio del MyDocsSite artefacto a Amazon S3 para su alojamiento.

nota

El siguiente ejemplo de flujo de trabajo tiene fines ilustrativos y no funcionará sin una configuración adicional.

nota

En el YAML código siguiente, puede omitir la Connections: sección si lo desea. Si omite esta sección, debe asegurarse de que la función especificada en el campo IAMFunción predeterminada de su entorno incluya los permisos y las políticas de confianza que exige la acción de publicación de Amazon S3. Para obtener más información sobre la configuración de un entorno con un IAM rol predeterminado, consulteCreación de un entorno. Para obtener más información sobre los permisos y las políticas de confianza que requiere la acción de publicación de Amazon S3, consulte la descripción de la Role propiedad enAcción «publicar en Amazon S3» YAML.

Name: codecatalyst-s3-publish-workflow
SchemaVersion: 1.0

Triggers:
  - Type: PUSH
    Branches:
      - main
Actions:
  BuildDocs:
    Identifier: aws/build@v1
    Inputs:
      Sources:
        - WorkflowSource
    Configuration:
      Steps:
        - Run: echo BuildDocs started on `date`
        - Run: pip install --upgrade pip
        - Run: pip install mkdocs
        - Run: mkdocs build
        - Run: echo BuildDocs completed on `date`
    Outputs:
      Artifacts:
      - Name: MyDocsSite
        Files:
          - "site/**/*"
        
  PublishToS3:
    Identifier: aws/s3-publish@v1
    Environment:
      Name: codecatalyst-s3-publish-environment
      Connections:
        - Name: codecatalyst-account-connection
          Role: codecatalyst-s3-publish-build-role
    Inputs:
      Sources:
        - WorkflowSource
      Artifacts:
        - MyDocsSite
    Configuration:      
      DestinationBucketName: amzn-s3-demo-bucket
      SourcePath: /artifacts/PublishToS3/MyDocSite/site
      TargetPath: my/docs/site