投稿

[GitHub 100日チャレンジ] Day 83 - Workflow構文を理解する

GitHub Actions workflowのname、on、jobs、steps、uses、runなど基本構文を整理します。

[GitHub 100日チャレンジ] Day 83 - Workflow構文を理解する

workflowの構造

GitHub Actionsのworkflowは、主に name、on、jobs で構成されます。

1
2
3
4
5
6
7
8
9
10
11
name: Test

on:
  pull_request:

jobs:
  test:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: npm test

onで起動条件を決める

on はworkflowを起動するイベントです。

1
2
3
4
5
on:
  push:
    branches: [main]
  pull_request:
  workflow_dispatch:

workflow_dispatch を入れると、GitHubの画面から手動実行できます。

stepsで処理を書く

uses は既存Actionを使うとき、run はshell commandを実行するときに使います。

1
2
3
4
steps:
  - uses: actions/checkout@v4
  - run: npm ci
  - run: npm test

今日のゴール

workflow構文は、いつ動かすか、どこで動かすか、何を実行するかをYAMLで表します。まずは基本の形を読めるようにしましょう。

この投稿は投稿者によって CC BY 4.0 の下でライセンスされています。