Undersøg en arbejdsprocesfil

Fuldført

GitHub Actions bruger YAML-syntaksen til at definere arbejdsprocessen. Hver arbejdsproces gemmes som en separat YAML-fil i kodelageret i en mappe med navnet .github/workflows. Følgende arbejdsproceseksempel udløses, når kode pushes til et lager. Arbejdsprocessen udfører følgende trin:

1. Tjekker den skubbede kode ud.
2. Installerer Node.js.
3. Installerer teststrukturen Bash Automated Testing System (Bats).
4. Kører en kommando til output af Bats-versionen: 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

Om arbejdsprocesfilen

For at hjælpe dig med at forstå, hvordan YAML-syntaks bruges til at oprette en arbejdsprocesfil, forklares hver linje i det forrige eksempel i dette afsnit:

# 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

Få vist aktiviteten for kørsel af en arbejdsproces

Når en arbejdsproces udløses, oprettes der en arbejdsproceskørsel, der udfører arbejdsprocessen. Når en arbejdsproceskørsel starter, kan du se en visualiseringsgraf over kørslens status og få vist hvert trins aktivitet på GitHub. Følg disse trin for at få vist aktiviteten:

1. Gå til lagerets hovedside.

2. Vælg Handlinger placeret under navnet på lageret.

3. Vælg den arbejdsproces, du vil se, i venstre margentekst.

4. Vælg navnet på kørslen på listen over kørsler af arbejdsprocesser for at se oversigten over kørsel af arbejdsprocessen.

5. Vælg det job, du vil se, i venstre margentekst eller i visualiseringsgrafen.

6. Vælg et trin for at få vist detaljerede resultater.

Nu, hvor du forstår komponenterne i arbejdsprocesfilen, kan du se, hvordan udviklere kan tilpasse filen til en række forskellige use cases.