Einen benutzerdefinierten Blueprint in einem Space veröffentlichen

Bevor Sie einen benutzerdefinierten Blueprint in den Blueprints-Katalog Ihres Spaces aufnehmen können, müssen Sie ihn im Space veröffentlichen. Sie können den Blueprint vor der Veröffentlichung auch in der CodeCatalyst Konsole anzeigen. Sie können eine Vorschauversion oder eine normale Version Ihres Blueprints veröffentlichen.

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.

Wichtig

Um einen benutzerdefinierten Blueprint in Ihrem CodeCatalyst Space zu veröffentlichen, müssen Sie mit einem Konto angemeldet sein, dem die Rolle Space-Administrator oder Poweruser in dem Bereich zugewiesen ist.

Eine Vorschauversion eines benutzerdefinierten Blueprints anzeigen und veröffentlichen

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.

Nachdem Sie die Änderungen vorgenommen haben, erstellen Sie das Paket Ihres benutzerdefinierten Blueprints neu, indem Sie die package.json Datei ausführen, und zeigen Sie eine Vorschau Ihrer Änderungen an.

Um eine Vorschauversion eines benutzerdefinierten Blueprints anzuzeigen und zu veröffentlichen

1. Setzen Sie Ihre Entwicklungsumgebung fort. Weitere Informationen finden Sie unter Fortsetzen einer Entwicklungsumgebung.

2. Öffnen Sie ein funktionierendes Terminal in Ihrer Entwicklungsumgebung.

3. (Optional) Installieren Sie in einem funktionierenden Terminal die erforderlichen Abhängigkeiten für Ihr Projekt, falls Sie sie nicht bereits installiert haben. Verwenden Sie den folgenden Befehl:

   yarn

4. (Optional) Wenn Sie Änderungen an der .projenrc.ts Datei vorgenommen haben, generieren Sie die Konfiguration Ihres Projekts neu, bevor Sie Ihren Blueprint erstellen und eine Vorschau anzeigen. Verwenden Sie den folgenden Befehl:

   yarn projen

5. Erstellen Sie Ihren benutzerdefinierten Blueprint mit dem folgenden Befehl neu und zeigen Sie eine Vorschau an. Verwenden Sie den folgenden Befehl:

   yarn blueprint:preview

   Navigieren Sie zu dem bereitgestellten See this blueprint at: Link, um eine Vorschau Ihres benutzerdefinierten Blueprints anzuzeigen. 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.

6. (Optional) Sie können eine Vorschauversion Ihres benutzerdefinierten Blueprints veröffentlichen, die dann dem Blueprints-Katalog Ihres Bereichs hinzugefügt werden kann. Navigiere zu dem Enable version [preview version number] at: Link, um eine Vorschauversion in deinem Space zu veröffentlichen.

Sie können die Projekterstellung emulieren, ohne ein Projekt in CodeCatalyst erstellen zu müssen. Verwenden Sie den folgenden Befehl, um Ihr Projekt zu synthetisieren:

yarn blueprint:synth

In dem Ordner wird ein Blueprint generiert. synth/synth.[options-name]/proposed-bundle/ Weitere Informationen finden Sie unter Synthese.

Wenn Sie Ihren benutzerdefinierten Blueprint aktualisieren, verwenden Sie stattdessen den folgenden Befehl, um Ihr Projekt neu zu synthetisieren:

yarn blueprint:resynth

In dem Ordner wird ein Blueprint generiert. synth/synth.[options-name]/proposed-bundle/ Weitere Informationen finden Sie unter Resynthese.

Nachdem Sie Ihre Vorschauversion veröffentlicht haben, können Sie den Blueprint hinzufügen, sodass Space-Mitglieder ihn verwenden können, um neue Projekte zu erstellen oder bestehende Projekte hinzuzufügen. Weitere Informationen finden Sie unter Hinzufügen eines benutzerdefinierten Blueprints zu einem Space-Blueprints-Katalog.

Eine normale Version eines benutzerdefinierten Blueprints anzeigen und veröffentlichen

Nachdem Sie mit der Entwicklung und der Vorschau Ihres benutzerdefinierten Blueprints fertig sind, können Sie die neue Version, die Sie dem Blueprints-Katalog Ihres Bereichs hinzufügen möchten, anzeigen und veröffentlichen. Der Release-Workflow, der bei der Erstellung eines Projekts generiert wird, veröffentlicht automatisch Änderungen, die übertragen werden. Wenn Sie bei der Erstellung des Blueprints die Workflow-Generierung deaktiviert haben, wird Ihr Blueprint nicht automatisch für das Hinzufügen zum Blueprints-Katalog Ihres Bereichs verfügbar gemacht. Sie können Ihren benutzerdefinierten Blueprint immer noch in Ihrem Space veröffentlichen, nachdem Sie einen Befehl ausgeführt haben. yarn

Um einen benutzerdefinierten Blueprint anzuzeigen und zu veröffentlichen

1. Setzen Sie Ihre Entwicklungsumgebung fort. Weitere Informationen finden Sie unter Fortsetzen einer Entwicklungsumgebung.

2. Öffnen Sie ein funktionierendes Terminal in Ihrer Entwicklungsumgebung.

3. • Wenn Sie sich bei der Erstellung Ihres Blueprints gegen die Generierung des Release-Workflows entschieden haben, verwenden Sie den folgenden Befehl:

     yarn blueprint:release

     Sie können immer noch zu dem bereitgestellten See this blueprint at: Link navigieren, um Ihren benutzerdefinierten Blueprint anzuzeigen.

     Veröffentlichen Sie die aktualisierte Version Ihres benutzerdefinierten Blueprints, der dann dem Blueprints-Katalog Ihres Bereichs hinzugefügt werden kann. Navigiere zu dem Enable version [release version number] at: Link, um die neueste Version in deinem Space zu veröffentlichen.

   • Wenn Sie sich bei der Erstellung Ihres Blueprints für einen Release-Workflow entschieden haben, wird die neueste Blueprint-Version automatisch veröffentlicht, wenn Änderungen veröffentlicht werden. Verwenden Sie die folgenden Befehle:

     git add .

     git commit -m "commit message"

     git push

Nachdem Sie Ihre normale Version veröffentlicht haben, können Sie den Blueprint hinzufügen, sodass Space-Mitglieder ihn verwenden können, um neue Projekte zu erstellen oder bestehende Projekte hinzuzufügen. Weitere Informationen finden Sie unter Hinzufügen eines benutzerdefinierten Blueprints zu einem Space-Blueprints-Katalog.

Einen benutzerdefinierten Blueprint in bestimmten Bereichen und Projekten veröffentlichen und hinzufügen

Standardmäßig werden die blueprint:release Befehle blueprint:preview und in dem CodeCatalyst Bereich veröffentlicht, in dem Sie den Blueprint erstellt haben. Wenn Sie über mehrere Enterprise-Bereiche verfügen, können Sie denselben Blueprint auch in diesen Bereichen als Vorschau anzeigen und veröffentlichen. Sie können auch einen Blueprint zu einem bestehenden Projekt eines anderen Bereichs hinzufügen.

Um einen benutzerdefinierten Blueprint in einem bestimmten Bereich zu veröffentlichen oder hinzuzufügen

1. Setzen Sie Ihre Entwicklungsumgebung fort. Weitere Informationen finden Sie unter Fortsetzen einer Entwicklungsumgebung.

2. Öffnen Sie ein funktionierendes Terminal in Ihrer Entwicklungsumgebung.

3. (Optional) Installieren Sie die erforderlichen Abhängigkeiten für Ihr Projekt, falls Sie sie nicht bereits installiert haben. Verwenden Sie den folgenden Befehl:

   yarn

4. Verwenden Sie das --space Tag, um eine Vorschauversion oder eine normale Version in einem bestimmten Bereich zu veröffentlichen. Beispielsweise:

   • yarn blueprint:preview --space my-awesome-space # publishes under a "preview" version tag to 'my-awesome-space'

     Beispielausgabe:

     Enable version 0.0.1-preview.0 at: https://codecatalyst.aws/spaces/my-awesome-space/blueprints
     Blueprint applied to [NEW]: https://codecatalyst.aws/spaces/my-awesome-space/blueprints/%40amazon-codecatalyst%2Fmyspace.my-blueprint/publishers/1524817d-a69b-4abe-89a0-0e4a9a6c53b2/versions/0.0.1-preview.0/projects/create

   • yarn blueprint:release --space my-awesome-space # publishes normal version to 'my-awesome-space'

     Beispielausgabe:

     Enable version 0.0.1 at: https://codecatalyst.aws/spaces/my-awesome-space/blueprints
     Blueprint applied to [NEW]: https://codecatalyst.aws/spaces/my-awesome-space/blueprints/%40amazon-codecatalyst%2Fmyspace.my-blueprint/publishers/1524817d-a69b-4abe-89a0-0e4a9a6c53b2/versions/0.0.1/projects/create

   Verwenden Sie das--project, um einem vorhandenen Projekt in einem bestimmten Bereich eine Vorschauversion eines benutzerdefinierten Blueprints hinzuzufügen. Beispielsweise:

   yarn blueprint:preview --space my-awesome-space --project my-project # previews blueprint application to an existing project

   Beispielausgabe:

   Enable version 0.0.1-preview.1 at: https://codecatalyst.aws/spaces/my-awesome-space/blueprints
   Blueprint applied to [my-project]: https://codecatalyst.aws/spaces/my-awesome-space/projects/my-project/blueprints/%40amazon-codecatalyst%2FmySpace.my-blueprint/publishers/1524817d-a69b-4abe-89a0-0e4a9a6c53b2/versions/0.0.1-preview.1/add