Exemple : publier des fichiers sur Amazon S3

L'exemple de flux de travail suivant inclut l'action de publication Amazon S3, ainsi qu'une action de génération. Le flux de travail crée un site Web de documentation statique, puis le publie sur Amazon S3, où il est hébergé. Le flux de travail comprend les éléments de base suivants qui s'exécutent de manière séquentielle :

• Un déclencheur : ce déclencheur lance automatiquement l'exécution du flux de travail lorsque vous apportez une modification à votre référentiel source. Pour plus d'informations sur les déclencheurs, consultez Démarrage d'un flux de travail exécuté automatiquement à l'aide de déclencheurs.

• Une action de construction (BuildDocs) — Au moment du déclenchement, l'action crée un site Web de documentation statique (mkdocs build) et ajoute les HTML fichiers associés et les métadonnées connexes à un artefact appeléMyDocsSite. Pour plus d'informations sur l'action de génération, consultezConstruire avec des flux de travail.

• Une action de publication Amazon S3 (PublishToS3) : une fois l'action de création terminée, cette action copie le site contenu dans l'MyDocsSiteartefact vers Amazon S3 pour l'hébergement.

Note

L'exemple de flux de travail suivant est fourni à titre d'illustration et ne fonctionnera pas sans configuration supplémentaire.

Note

Dans le YAML code qui suit, vous pouvez omettre la Connections: section si vous le souhaitez. Si vous omettez cette section, vous devez vous assurer que le rôle spécifié dans le champ IAMRôle par défaut de votre environnement inclut les autorisations et les politiques de confiance requises par l'action de publication Amazon S3. Pour plus d'informations sur la configuration d'un environnement doté d'un IAM rôle par défaut, consultezCréation d'un environnement. Pour plus d'informations sur les autorisations et les politiques de confiance requises par l'action de publication Amazon S3, consultez la description de la Role propriété dans leAction « Publier sur 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