[GitHub 100日チャレンジ] Day 82 - GitHub Actionsを始める

GitHub Actionsの基本

GitHub Actionsでは、.github/workflows/ にYAMLファイルを置いて自動化を定義します。

name: CI

on:
  pull_request:
  push:
    branches: [main]

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

主な要素

上のYAMLはworkflowの最小構造を読むための例です。npm testを実際に動かすには、Repositoryにpackage.jsonのtestスクリプトがあり、依存関係がインストールされている必要があります。Day 83のsteps例のような準備を加え、Actionsログでテスト処理そのものが実行されたか確認します。GitHub公式のNode.js CI説明も参考になります。

• workflow: 自動化全体
• event: workflowを起動するきっかけ
• job: 実行単位
• step: job内の個別処理
• action: 再利用できる処理

最初に作るなら

まずはPull Request時にテストを実行するworkflowが分かりやすいです。小さく始めて、ビルド、lint、デプロイへ広げていきます。

今日のゴール

GitHub ActionsはYAMLで定義する自動化です。workflow、job、stepの関係を理解し、最初のCIを作れるようにしましょう。