Työnkulkutiedoston tutkiminen

Valmis

GitHub Actions käyttää YAML-syntaksia työnkulun määrittämiseen. Kukin työnkulku tallennetaan koodin säilöön erillisenä YAML-tiedostona hakemistoon, jonka nimi on .github/workflows. Seuraava esimerkki työnkulusta käynnistyy aina, kun koodi lähetetään säilöön. Työnkulku suorittaa seuraavat vaiheet:

1. Tarkistaa lähetetyn koodin.
2. Asentaa Node.js.
3. Asentaa Bashin automatisoidun testausjärjestelmän (Bats) testauskehyksen.
4. Suorittaa komennon, joka tulostaa Bats-version: 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

Työnkulkutiedoston ymmärtäminen

Tässä osiossa kerrotaan edellisen esimerkin jokaisesta rivistä, miten YAML-syntaksia käytetään työnkulkutiedoston luomiseen:

# 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

Tarkastele työnkulun suorituksen toimintaa

Kun työnkulku käynnistetään, luodaan työnkulun suoritus, joka suorittaa työnkulun. Kun työnkulun suorittaminen käynnistyy, näet visualisointikaavion suorituksen edistymisestä ja voit tarkastella kunkin vaiheen toimintaa GitHubissa. Voit tarkastella toimintoa seuraavasti:

1. Siirry säilön pääsivulle.

2. Valitse säilön nimen alta Toiminnot.

3. Valitse vasemmasta sivupalkista työnkulku, jonka haluat nähdä.

4. Valitse työnkulun suoritusluettelosta suorituksen nimi, jotta näet työnkulun suorituksen yhteenvedon.

5. Valitse vasemmasta sivupalkista tai visualisointikaaviosta työ, jonka haluat nähdä.

6. Valitse vaihe yksityiskohtaisten tulosten tarkastelemiseksi.

Nyt kun ymmärrät työnkulkutiedoston osat, näet, miten kehittäjät voivat mukauttaa tiedostoa erilaisissa käyttötapauksissa.