Exemplo de fluxo de trabalho que publica arquivos no Amazon S3

O exemplo de fluxo de trabalho a seguir inclui a ação de publicação do Amazon S3, junto com uma ação de criação. O fluxo de trabalho cria um site de documentação estática e depois o publica no Amazon S3, onde está hospedado. O fluxo de trabalho consiste nos seguintes blocos de construção que são executados sequencialmente:

• Um gatilho — Esse gatilho inicia a execução automática do fluxo de trabalho quando você envia uma alteração ao seu repositório de origem. Para obter mais informações sobre gatilhos, consulte Iniciando um fluxo de trabalho executado automaticamente com gatilhos.

• Uma ação de construção (BuildDocs) — No gatilho, a ação cria um site de documentação estática (mkdocs build) e adiciona os arquivos HTML associados e os metadados de suporte a um artefato chamado. MyDocsSite Para obter mais informações sobre a ação de criação, consulteConstruindo com fluxos de trabalho.

• Uma ação de publicação do Amazon S3 (PublishToS3) — Ao concluir a ação de criação, essa ação copia o site no MyDocsSite artefato para o Amazon S3 para hospedagem.

nota

O exemplo de fluxo de trabalho a seguir serve para fins ilustrativos e não funcionará sem configuração adicional.

nota

No código YAML a seguir, você pode omitir a Connections: seção se quiser. Se você omitir esta seção, deverá garantir que a função especificada no campo Função padrão do IAM em seu ambiente inclua as permissões e as políticas de confiança exigidas pela ação de publicação do Amazon S3. Para obter mais informações sobre como configurar um ambiente com uma função padrão do IAM, consulteCriar um ambiente. Para obter mais informações sobre as permissões e políticas de confiança exigidas pela ação de publicação do Amazon S3, consulte a descrição da Role propriedade no. Definição YAML da ação “Amazon S3 publish”

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: my-bucket
      SourcePath: /artifacts/PublishToS3/MyDocSite/site
      TargetPath: my/docs/site