Beispiel: Dateien auf Amazon S3 veröffentlichen

Der folgende Beispiel-Workflow umfasst die Amazon S3 S3-Veröffentlichungsaktion zusammen mit einer Build-Aktion. Der Workflow erstellt eine statische Dokumentationswebsite und veröffentlicht sie dann in Amazon S3, wo sie gehostet wird. Der Workflow besteht aus den folgenden Bausteinen, die nacheinander ausgeführt werden:

• Ein Trigger — Dieser Trigger startet die Workflow-Ausführung automatisch, wenn Sie eine Änderung an Ihr Quell-Repository übertragen. Weitere Informationen zu Auslösern finden Sie unter Automatisches Starten einer Workflow-Ausführung mithilfe von Triggern.

• Eine Build-Aktion (BuildDocs) — Beim Trigger erstellt die Aktion eine statische Dokumentationswebsite (mkdocs build) und fügt die zugehörigen HTML Dateien und unterstützenden Metadaten zu einem Artefakt mit dem Namen MyDocsSite hinzu. Weitere Informationen zur Build-Aktion finden Sie unterBauen mit Workflows.

• Eine Amazon S3-Veröffentlichungsaktion (PublishToS3) — Nach Abschluss der Build-Aktion kopiert diese Aktion die Site im MyDocsSite Artefakt zum Hosten nach Amazon S3.

Anmerkung

Das folgende Workflow-Beispiel dient der Veranschaulichung und funktioniert ohne zusätzliche Konfiguration nicht.

Anmerkung

Im folgenden YAML Code können Sie den Connections: Abschnitt weglassen, wenn Sie möchten. Wenn Sie diesen Abschnitt weglassen, müssen Sie sicherstellen, dass die im Feld Standardrolle angegebene IAM Rolle in Ihrer Umgebung die Berechtigungen und Vertrauensrichtlinien enthält, die für die Amazon S3 S3-Veröffentlichungsaktion erforderlich sind. Weitere Informationen zum Einrichten einer Umgebung mit einer IAM Standardrolle finden Sie unterErstellen einer Umgebung. Weitere Informationen zu den Berechtigungen und Vertrauensrichtlinien, die für die Amazon S3 S3-Veröffentlichungsaktion erforderlich sind, finden Sie in der Beschreibung der Role Eigenschaft in derAktion „Amazon S3 veröffentlichen“ 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: my-bucket
      SourcePath: /artifacts/PublishToS3/MyDocSite/site
      TargetPath: my/docs/site