Erstellen einer zusammengesetzten Aktion

Einführung

In dieser Anleitung erfährst du mehr über die grundlegenden Komponenten, die benötigt werden, um eine paketierte zusammengesetzte Aktion zu erstellen und zu verwenden. Diese Anleitung fokussiert jene Komponenten, welche zum Paketieren der Aktion benötigt werden. Daher hat der Aktions-Code nur minimale Funktionalität. Die Aktion gibt „Hello World“ und dann „Goodbye“ bzw. nach Angabe eines benutzerdefinierten Namens „Hello [who-to-greet]“ und dann „Goodbye“ aus. Zudem ordnet die Aktion der Ausgabevariablen random-number eine Zufallszahl zu und führt ein Skript namens goodbye.sh aus.

Nach dem Abschluss dieses Projekts weißt du, wie du eine eigene zusammengesetzte Aktion erstellen und in einem Workflow testen kannst.

Warnung: Beim Erstellen von Workflows und Aktionen solltest du immer überprüfen, ob dein Code gegebenenfalls nicht vertrauenswürdige Eingaben von Angreifern ausführen kann. Bestimmte Kontexte sollten als nicht vertrauenswürdige Eingaben behandelt werden, da ein Angreifer seine eigenen schädlichen Inhalte einfügen könnte. Weitere Informationen findest du unter Sicherheitshärtung für GitHub Actions.

Voraussetzungen

Bevor du beginnst, erstellst du ein Repository auf GitHub.com.

Erstelle ein neues öffentliches Repository auf GitHub.com. Du kannst einen beliebigen Repositorynamen auswählen oder das folgende hello-world-composite-action-Beispiel verwenden. Du kannst diese Dateien hinzufügen, nachdem dein Projekt per Push an GitHub Enterprise Cloud übergeben wurde. Weitere Informationen findest du unter Ein neues Repository erstellen.
Klone dein Repository auf deinen Computer. Weitere Informationen findest du unter Ein Repository klonen.
Gehe in deinem Terminal zum Verzeichnisse deines neuen Repositorys.
Shell
```
cd hello-world-composite-action
```
```
cd hello-world-composite-action
```
Erstelle im Repository hello-world-composite-action eine neue Datei namens goodbye.sh, und füge den folgenden Beispielcode hinzu:
Bash
```
echo "Goodbye"
```
```
echo "Goodbye"
```
Lege goodbye.sh über das Terminal als ausführbare Datei fest.
Shell
```
chmod +x goodbye.sh
```
```
chmod +x goodbye.sh
```

Checke die Datei goodbye.sh über das Terminal ein.

Shell

git add goodbye.sh
git commit -m "Add goodbye script"
git push

git add goodbye.sh
git commit -m "Add goodbye script"
git push

Eine Datei für die Metadaten der Aktion erstellen

Erstelle im Repository hello-world-composite-action eine neue Datei namens action.yml, und füge den folgenden Beispielcode hinzu. Weitere Informationen zu dieser Syntax findest du unter Metadatensyntax für GitHub Actions.

action.yml

```yaml copy
name: 'Hello World'
description: 'Greet someone'
inputs:
  who-to-greet:  # id of input
    description: 'Who to greet'
    required: true
    default: 'World'
outputs:
  random-number:
    description: "Random number"
    value: ${{ steps.random-number-generator.outputs.random-number }}
runs:
  using: "composite"
  steps:
    - run: echo Hello ${{ inputs.who-to-greet }}.
      shell: bash
    - id: random-number-generator
      run: echo "random-number=$(echo $RANDOM)" >> $GITHUB_OUTPUT
      shell: bash
    - run: echo "${{ github.action_path }}" >> $GITHUB_PATH
      shell: bash
    - run: goodbye.sh
      shell: bash
```

Diese Datei definiert die who-to-greet-Eingabe, ordnet die zufällig generierte Zahl der Ausgabevariablen random-number zu, fügt den Pfad der Aktion zum Systempfad des Runners hinzu (um das Skript goodbye.sh während der Ausführung ausfindig zu machen) und führt das Skript goodbye.sh aus.

Weitere Informationen zur Verwaltung von Ausgaben findest du unter [AUTOTITLE](/actions/creating-actions/metadata-syntax-for-github-actions#outputs-for-composite-actions).

Weitere Informationen zur Verwendung von `github.action_path` findest du unter [AUTOTITLE](/actions/learn-github-actions/contexts#github-context).

Checke die Datei action.yml über das Terminal ein.

Shell

git add action.yml
git commit -m "Add action"
git push

git add action.yml
git commit -m "Add action"
git push

Füge über das Terminal ein Tag hinzu. In diesem Beispiel wird ein Tag namens v1 verwendet. Weitere Informationen findest du unter Informationen zu benutzerdefinierten Aktionen.
Shell
```
git tag -a -m "Description of this release" v1
git push --follow-tags
```
```
git tag -a -m "Description of this release" v1
git push --follow-tags
```

Deine Aktion in einem Workflow testen

Der folgende Workflowcode verwendet die abgeschlossene „Hello World“-Aktion, die du unter Erstellen einer zusammengesetzten Aktion erstellt hast.

Kopiere den Workflowcode in eine Datei .github/workflows/main.yml in einem anderen Repository, aber ersetze actions/hello-world-composite-action@v1 durch das von dir erstellte Repository und Tag. Du kannst auch die Eingabe für who-to-greet durch deinen Namen ersetzen.

.github/workflows/main.yml

YAML

on: [push]

jobs:
  hello_world_job:
    runs-on: ubuntu-latest
    name: A job to say hello
    steps:
      - uses: actions/checkout@v4
      - id: foo
        uses: actions/hello-world-composite-action@v1
        with:
          who-to-greet: 'Mona the Octocat'
      - run: echo random-number ${{ steps.foo.outputs.random-number }}
        shell: bash

on: [push]

jobs:
  hello_world_job:
    runs-on: ubuntu-latest
    name: A job to say hello
    steps:
      - uses: actions/checkout@v4
      - id: foo
        uses: actions/hello-world-composite-action@v1
        with:
          who-to-greet: 'Mona the Octocat'
      - run: echo random-number ${{ steps.foo.outputs.random-number }}
        shell: bash

Klicke in deinem Repository auf die Registerkarte Aktionen, und wähle die neueste Workflowausführung aus. Die Ausgabe sollte Folgendes enthalten: „Hello Mona the Octocat“, das Ergebnis des Skripts „Goodbye“ und eine zufällige Zahl.

Beispiele für zusammengesetzte Aktionen unter GitHub.com

Viele Beispiele für zusammengesetzte Aktionen findest du unter GitHub.com.