Untersuchen einer Workflowdatei

Abgeschlossen

GitHub-Aktionen verwenden YAML-Syntax zum Definieren des Workflows. Jeder Workflow wird als separate YAML-Datei in Ihrem Coderepository in einem Verzeichnis mit dem Namen .github/workflowsgespeichert. Das folgende Workflowbeispiel wird ausgelöst, wenn Code an ein Repository übertragen wird. Der Workflow führt die folgenden Schritte aus:

1. Checkt den gepushten Code aus.
2. Installiert Node.js.
3. Installiert das Bash Automated Testing System (Bats)-Testframework.
4. Führt einen Befehl aus, um die Bats-Version auszugeben: bats -v.

name: learn-github-actions
run-name: ${{ github.actor }} is learning GitHub Actions
on: [push]
jobs:
  check-bats-version:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: '20'
      - run: npm install -g bats
      - run: bats -v

Grundlegendes zur Workflowdatei

Um zu verstehen, wie die YAML-Syntax zum Erstellen einer Workflowdatei verwendet wird, wird in diesem Abschnitt jede Zeile des vorherigen Beispiels erläutert:

# Optional - The name of the workflow as it will appear in the "Actions" tab of the GitHub repository. If this field is omitted, the name of the workflow file will be used instead.
name: learn-github-actions

# Optional - The name for workflow runs generated that appear in the list of workflow runs on your repository's "Actions" tab. This example uses an expression with the 'github' context to display the username of the actor that triggered the workflow run. 
run-name: ${{ github.actor }} is learning GitHub Actions

# Specifies the trigger for this workflow. This example uses the 'push' event, so a workflow run is triggered every time someone pushes a change to the repository or merges a pull request.
on: [push]

# Groups together all the jobs that run in the 'learn-github-actions' workflow.
jobs:

# Defines a job named 'check-bats-version'. The child keys will define properties of the job.
  check-bats-version:

# Configures the job to run on the latest version of an Ubuntu Linux runner. This means that the job will execute on a fresh virtual machine hosted by GitHub.
    runs-on: ubuntu-latest

# Groups together all the steps that run in the 'check-bats-version' job. Each item nested under this section is a separate action or shell script.
    steps:

# The 'uses' keyword specifies that this step will run 'v4' of the 'actions/checkout' action. This is an action that checks out your repository onto the runner, allowing you to run scripts or other actions against your code (such as build and test tools). You should use the checkout action any time your workflow will use the repository's code.
      - uses: actions/checkout@v4

# This step uses the 'actions/setup-node@v4' action to install the specified version of the Node.js. (This example uses version 20.) This puts both the 'node' and 'npm' commands in your PATH.
      - uses: actions/setup-node@v4
        with:
          node-version: '20'

# The 'run' keyword tells the job to execute a command on the runner. In this case, you are using 'npm' to install the 'bats' software testing package.
      - run: npm install -g bats

# The 'bats' command with a parameter that outputs the software version.
      - run: bats -v

Anzeigen der Aktivität für eine Workflowausführung

Wenn ein Workflow ausgelöst wird, wird eine Workflowausführung erstellt, die den Workflow ausführt. Nachdem ein Workflow gestartet wurde, können Sie ein Visualisierungsdiagramm des Fortschritts der Ausführung anzeigen und die Aktivitäten der einzelnen Schritte auf GitHub anzeigen. Führen Sie die folgenden Schritte aus, um die Aktivität anzuzeigen:

1. Navigieren Sie zur Hauptseite des Repositorys.

2. Wählen Sie Aktionen unter dem Repositorynamen aus.

3. Wählen Sie in der linken Randleiste den Workflow aus, den Sie anzeigen möchten.

4. Wählen Sie in der Liste der Workflowausführungen den Namen der Ausführung aus, um die Zusammenfassung der Workflowausführung anzuzeigen.

5. Wählen Sie in der linken Randleiste oder im Visualisierungsdiagramm den Auftrag aus, den Sie anzeigen möchten.

6. Wählen Sie einen Schritt aus, um detaillierte Ergebnisse anzuzeigen.

Nachdem Sie nun die Workflowdateikomponenten verstanden haben, können Sie sehen, wie Entwickler die Datei für eine Vielzahl von Anwendungsfällen anpassen können.