Erste Schritte mit benutzerdefinierten Blueprints - Amazon CodeCatalyst
VoraussetzungenSchritt 1: Erstellen Sie einen benutzerdefinierten Blueprint in CodeCatalystSchritt 2: Entwickeln Sie einen benutzerdefinierten Blueprint mit KomponentenSchritt 3: Vorschau eines benutzerdefinierten Blueprints(Optional) Schritt 4: Veröffentlichen Sie eine benutzerdefinierte Blueprint-Vorschauversion

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Erste Schritte mit benutzerdefinierten Blueprints

Während der Erstellung eines Blueprints können Sie den Blueprint konfigurieren und eine Vorschau der Projektressourcen generieren. Jeder benutzerdefinierte Blueprint wird von einem CodeCatalyst Projekt verwaltet, das standardmäßig einen Workflow für die Veröffentlichung im Blueprints-Katalog des Bereichs enthält.

Bei der Konfiguration der Details Ihres benutzerdefinierten Blueprints können Sie sich auch dafür entscheiden, den Quellcode Ihres Blueprints in einem Drittanbieter-Repository zu speichern, wo Sie den benutzerdefinierten Blueprint weiterhin verwalten und die Lebenszyklusverwaltungsfunktionen nutzen können, um die Projekte Ihres Bereichs zu synchronisieren, wenn der benutzerdefinierte Blueprint geändert wird. Weitere Informationen finden Sie unter Fügen Sie Funktionen zu Projekten mit Erweiterungen hinzu in CodeCatalyst und Arbeiten mit Lebenszyklusmanagement als Blueprint-Autor.

Wenn Sie bereits über ein Quell-Repository mit Standardisierung und bewährten Methoden verfügen, können Sie dieses Quell-Repository in einen benutzerdefinierten Blueprint konvertieren. Weitere Informationen finden Sie unter Quell-Repositorys in benutzerdefinierte Blueprints konvertieren.

Voraussetzungen

Bevor Sie einen benutzerdefinierten Blueprint erstellen, sollten Sie die folgenden Anforderungen berücksichtigen:

  • Ihr CodeCatalyst Bereich muss der Enterprise-Stufe entsprechen. Weitere Informationen finden Sie unter Abrechnung verwalten im CodeCatalyst Amazon-Administratorhandbuch.

  • Sie benötigen die Rolle Space-Administrator oder Poweruser, um benutzerdefinierte Blueprints erstellen zu können. Weitere Informationen finden Sie unter Zugriff mit Benutzerrollen gewähren.

Schritt 1: Erstellen Sie einen benutzerdefinierten Blueprint in CodeCatalyst

Wenn Sie anhand der Einstellungen Ihres Bereichs einen benutzerdefinierten Blueprint erstellen, wird ein Repository für Sie erstellt. Das Repository enthält alle erforderlichen Ressourcen, die Sie benötigen, um Ihren Blueprint zu entwickeln, bevor Sie ihn im Blueprints-Katalog des Spaces veröffentlichen.

Um einen benutzerdefinierten Blueprint zu erstellen

  1. Öffnen Sie die CodeCatalyst Konsole unter https://codecatalyst.aws/.

  2. Navigieren Sie in der CodeCatalyst Konsole zu dem Bereich, in dem Sie einen benutzerdefinierten Blueprint erstellen möchten.

  3. Wählen Sie im Space-Dashboard die Registerkarte Einstellungen und dann Blueprints aus.

  4. Wählen Sie Blueprint erstellen aus.

  5. Geben Sie unter Name Ihres Blueprints den Namen ein, den Sie Ihrem Projekt zuweisen möchten, sowie die zugehörigen Ressourcennamen. Der Name muss in Ihrem Bereich eindeutig sein.

  6. (Optional) Standardmäßig wird der durch den Blueprint erstellte Quellcode in einem CodeCatalyst Repository gespeichert. Sie können sich auch dafür entscheiden, den Quellcode des Blueprints in einem Drittanbieter-Repository zu speichern. Weitere Informationen finden Sie unter Fügen Sie Funktionen zu Projekten mit Erweiterungen hinzu in CodeCatalyst.

    Führen Sie je nach dem Drittanbieter-Repository-Anbieter, den Sie verwenden möchten, einen der folgenden Schritte aus:

    • GitHub Repositorien: Connect ein GitHub Konto.

      Wählen Sie das Dropdownmenü Erweitert, wählen Sie GitHub als Repository-Anbieter aus und wählen Sie dann das GitHub Konto aus, in dem Sie den durch den Blueprint erstellten Quellcode speichern möchten.

      Anmerkung

      Wenn Sie eine Verbindung zu einem GitHub Konto verwenden, müssen Sie eine persönliche Verbindung herstellen, um eine Identitätszuordnung zwischen Ihrer Identität und Ihrer CodeCatalyst GitHub Identität herzustellen. Weitere Informationen finden Sie unter Persönliche Verbindungen und Zugreifen auf GitHub Ressourcen mit persönlichen Verbindungen.

    • Bitbucket-Repositorys: Connect einen Bitbucket-Workspace.

      Wähle das Dropdownmenü „Erweitert“, wähle Bitbucket als Repository-Anbieter und wähle dann den Bitbucket-Workspace aus, in dem du den durch den Blueprint erstellten Quellcode speichern möchtest.

    • GitLab Repositorien: Verbindet einen GitLab Benutzer.

      Wählen Sie das Dropdownmenü Erweitert, wählen Sie GitLab als Repository-Anbieter aus und wählen Sie dann den GitLab Benutzer aus, für den Sie den durch den Blueprint erstellten Quellcode speichern möchten.

  7. Gehen Sie unter Blueprint-Details wie folgt vor:

    1. Geben Sie im Texteingabefeld für den Namen der Blueprint-Anzeige einen Namen ein, der im Blueprints-Katalog Ihres Bereichs erscheinen soll.

    2. Geben Sie im Texteingabefeld Beschreibung eine Beschreibung für Ihren benutzerdefinierten Blueprint ein.

    3. Geben Sie im Texteingabefeld Autorenname einen Autorennamen für Ihren benutzerdefinierten Blueprint ein.

    4. (Optional) Wählen Sie die erweiterten Einstellungen.

      1. Wählen Sie + Hinzufügen, um Tags hinzuzufügen, die der package.json Datei hinzugefügt wurden.

      2. Wählen Sie das Dropdownmenü Lizenz und wählen Sie dann eine Lizenz für Ihren benutzerdefinierten Blueprint aus.

      3. Geben Sie im Texteingabefeld für den Namen des Blueprint-Pakets einen Namen ein, um Ihr Blueprint-Paket zu identifizieren.

      4. Standardmäßig wird ein Release-Workflow mithilfe eines Veröffentlichungs-Blueprints in Ihrem Projekt namens Blueprint Builder generiert. Der Workflow veröffentlicht die neueste Blueprint-Version in Ihrem Bereich, wenn Sie Änderungen per Push übertragen, da die Veröffentlichungsberechtigungen durch den Release-Workflow aktiviert werden. Um die Workflow-Generierung zu deaktivieren, deaktivieren Sie das Kontrollkästchen Workflow veröffentlichen.

  8. (Optional) Ein Blueprint-Projekt enthält vordefinierten Code, der die Veröffentlichung des Blueprints im Blueprints-Katalog des Bereichs unterstützt. Um Definitionsdateien mit Aktualisierungen auf der Grundlage der von Ihnen ausgewählten Projektparameter anzuzeigen, wählen Sie unter Blueprint-Vorschau generieren die Option Code anzeigen oder Workflow anzeigen aus.

  9. Wählen Sie Blueprint erstellen aus.

Wenn Sie die Workflow-Generierung für Ihren benutzerdefinierten Blueprint nicht deaktiviert haben, wird der Workflow automatisch ausgeführt, wenn Ihr Blueprint erstellt wird. Wenn die Workflow-Ausführung abgeschlossen ist, kann Ihr benutzerdefinierter Blueprint standardmäßig zum Blueprints-Katalog Ihres Bereichs hinzugefügt werden. Sie können die Veröffentlichungsberechtigungen deaktivieren, wenn Sie nicht möchten, dass die neueste Blueprint-Version automatisch in Ihrem Bereich veröffentlicht wird. Weitere Informationen finden Sie unter Veröffentlichungsberechtigungen für einen benutzerdefinierten Blueprint festlegen und Einen Workflow ausführen.

Da der aufgerufene Veröffentlichungsworkflow mithilfe eines Blueprints erstellt blueprint-release wird, kann der Blueprint als angewendeter Blueprint in Ihrem Projekt gefunden werden. Weitere Informationen finden Sie unter Hinzufügen eines Blueprints zu einem Projekt zur Integration von Ressourcen und Trennen der Zuordnung eines Blueprints zu einem Projekt, um Aktualisierungen zu beenden.

Schritt 2: Entwickeln Sie einen benutzerdefinierten Blueprint mit Komponenten

Wenn Sie einen benutzerdefinierten Blueprint erstellen, wird ein Blueprint-Assistent generiert, der bei der Entwicklung des benutzerdefinierten Blueprints mit Komponenten geändert werden kann. Sie können die src/defaults.json Dateien src/blueprints.js und aktualisieren, um den Assistenten zu ändern.

Wichtig

Wenn Sie Blueprint-Pakete aus externen Quellen verwenden möchten, sollten Sie die Risiken berücksichtigen, die mit diesen Paketen verbunden sein können. Sie sind verantwortlich für die benutzerdefinierten Blueprints, die Sie Ihrem Bereich hinzufügen, und für den Code, den sie generieren.

Erstellen Sie in Ihrem CodeCatalyst Projekt eine Entwicklungsumgebung mit einer unterstützten integrierten Entwicklungsumgebung (IDE), bevor Sie Ihren Blueprint-Code konfigurieren. Eine Entwicklungsumgebung ist erforderlich, um mit den erforderlichen Tools und Paketen arbeiten zu können.

Um eine Entwicklungsumgebung zu erstellen

  1. Führen Sie im Navigationsbereich einen der folgenden Schritte aus:

    1. Wählen Sie Überblick und navigieren Sie dann zum Abschnitt Meine Entwicklungsumgebungen.

    2. Wählen Sie Code und dann Entwicklungsumgebungen aus.

    3. Wählen Sie Code, dann Quell-Repositorys und dann das Repository aus, das Sie bei der Erstellung Ihres Blueprints erstellt haben.

  2. Wählen Sie Create Dev Environment aus.

  3. Wählen Sie eine unterstützte IDE aus dem Drop-down-Menü aus. Weitere Informationen finden Sie unter Unterstützte integrierte Entwicklungsumgebungen für Entwicklungsumgebungen.

  4. Wählen Sie In vorhandenem Zweig arbeiten aus und wählen Sie im Dropdownmenü Bestehender Zweig den Feature-Branch aus, den Sie erstellt haben.

  5. (Optional) Geben Sie im Texteingabefeld Alias — optionales Texteingabefeld einen Alias ein, um die Entwicklungsumgebung zu identifizieren.

  6. Wählen Sie Erstellen. Während Ihre Entwicklungsumgebung erstellt wird, wird in der Statusspalte Entwicklungsumgebung der Wert Wird gestartet angezeigt, und in der Statusspalte wird ausgeführt angezeigt, wenn die Entwicklungsumgebung erstellt wurde.

Weitere Informationen finden Sie unter Schreiben und ändern Sie Code mit Dev Environments in CodeCatalyst.

Um Ihren individuellen Blueprint zu entwickeln

  1. Verwenden Sie in einem funktionierenden Terminal den folgenden yarn Befehl, um Abhängigkeiten zu installieren:

    yarn

    Die erforderlichen Tools und Pakete werden über die CodeCatalyst Entwicklungsumgebung zur Verfügung gestellt, einschließlich Yarn. Wenn Sie an einem benutzerdefinierten Blueprint ohne Entwicklungsumgebung arbeiten, installieren Sie Yarn zuerst auf Ihrem System. Weitere Informationen finden Sie in der Installationsdokumentation von Yarn.

  2. Entwickeln Sie Ihren benutzerdefinierten Blueprint so, dass er nach Ihren Wünschen konfiguriert ist. Sie können den Assistenten Ihres Blueprints ändern, indem Sie Komponenten hinzufügen. Weitere Informationen finden Sie unter Entwicklung eines maßgeschneiderten Entwurfs zur Erfüllung der Projektanforderungen, Ändern von Blueprint-Funktionen mit einem Front-End-Assistenten und Einen benutzerdefinierten Blueprint in einem Space veröffentlichen.

Schritt 3: Vorschau eines benutzerdefinierten Blueprints

Nachdem Sie Ihren benutzerdefinierten Blueprint eingerichtet und entwickelt haben, können Sie eine Vorschau der Vorschauversion Ihres Blueprints anzeigen und in Ihrem Bereich veröffentlichen. Mit einer Vorschauversion können Sie überprüfen, ob der Blueprint Ihren Wünschen entspricht, bevor er zum Erstellen neuer Projekte verwendet oder auf bestehende Projekte angewendet wird.

Um eine Vorschau eines benutzerdefinierten Blueprints anzuzeigen

  1. Verwenden Sie in einem funktionierenden Terminal den folgenden yarn Befehl:

    yarn blueprint:preview

  2. Navigieren Sie zu dem bereitgestellten See this blueprint at: Link, um eine Vorschau Ihres benutzerdefinierten Blueprints anzuzeigen.

  3. Vergewissern Sie sich, dass die Benutzeroberfläche, einschließlich Text, so aussieht, wie Sie es aufgrund Ihrer Konfiguration erwartet haben. Wenn Sie Ihren benutzerdefinierten Blueprint ändern möchten, können Sie die blueprint.ts Datei bearbeiten, den Blueprint erneut synthetisieren und dann erneut eine Vorschauversion veröffentlichen. Weitere Informationen finden Sie unter Resynthese.

(Optional) Schritt 4: Veröffentlichen Sie eine benutzerdefinierte Blueprint-Vorschauversion

Sie können eine Vorschauversion Ihres benutzerdefinierten Blueprints in Ihrem Space veröffentlichen, wenn Sie ihn dem Blueprints-Katalog Ihres Bereichs hinzufügen möchten. Auf diese Weise können Sie sich den Blueprint als Benutzer ansehen, bevor Sie die Version, die keine Vorschauversion ist, zum Katalog hinzufügen. Mit der Vorschauversion können Sie veröffentlichen, ohne eine aktuelle Version verwenden zu müssen. Wenn Sie beispielsweise an einer 0.0.1 Version arbeiten, können Sie eine Vorschauversion veröffentlichen und hinzufügen, sodass neue Updates für eine zweite Version veröffentlicht und hinzugefügt werden können0.0.2.

Um eine Vorschauversion eines benutzerdefinierten Blueprints zu veröffentlichen

Navigieren Sie zu dem bereitgestellten Enable version [version number] at: Link, um Ihren benutzerdefinierten Blueprint zu aktivieren. Dieser Link wird bereitgestellt, wenn Sie den yarn Befehl in Schritt 3: Vorschau eines benutzerdefinierten Blueprints ausführen.

Nachdem Sie Ihren benutzerdefinierten Blueprint erstellt, entwickelt, in der Vorschau angezeigt und veröffentlicht haben, können Sie die endgültige Blueprint-Version veröffentlichen und dem Blueprint-Katalog Ihres Bereichs hinzufügen. Weitere Informationen finden Sie unter Einen benutzerdefinierten Blueprint in einem Space veröffentlichen und Hinzufügen eines benutzerdefinierten Blueprints zu einem Space-Blueprints-Katalog.