Prozkoumání souboru pracovního postupu

Dokončeno

GitHub Actions k definování pracovního postupu používá syntaxi YAML. Každý pracovní postup je uložen jako samostatný soubor YAML v úložišti kódu v adresáři s názvem .github/workflows. Následující příklad pracovního postupu se aktivuje při každém nasdílení kódu do úložiště. Pracovní postup provádí následující kroky:

  1. Zkontroluje vložený kód.
  2. Nainstaluje Node.js.
  3. Nainstaluje testovací architekturu Bash Automated Testing System (Bats).
  4. Spustí příkaz pro výstup verze Bats: 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

Porozumění souboru pracovního postupu

Tato část vysvětluje, jak se syntaxe YAML používá k vytvoření souboru pracovního postupu, vysvětluje každý řádek předchozího příkladu:

# 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

Zobrazení aktivity pro spuštění pracovního postupu

Při spuštění pracovního postupu se vytvoří běh, který tento pracovní postup vykoná. Po spuštění pracovního postupu můžete zobrazit vizualizační graf průběhu a sledovat průběh jednotlivých kroků na GitHubu. Pokud chcete zobrazit aktivitu, postupujte takto:

  1. Přejděte na hlavní stránku úložiště.

  2. Vyberte Akce umístěné pod názvem úložiště. Snímek obrazovky s umístěním tlačítka Akce

  3. Na levém bočním panelu vyberte pracovní postup, který chcete zobrazit.

  4. V seznamu spuštění pracovního postupu vyberte název spuštění a zobrazte souhrn spuštění pracovního postupu.

  5. Na levém bočním panelu nebo v grafu vizualizace vyberte úlohu, kterou chcete zobrazit.

  6. Výběrem kroku zobrazíte podrobné výsledky.

Teď, když rozumíte komponentám souborů pracovního postupu, uvidíte, jak můžou vývojáři soubor přizpůsobit pro různé případy použití.