⚙️

GitHub Actionsを使ってみる

に公開

GitHub Actionsとは?

GitHubでCI/CDを実現できるツール
リポジトリへのpushなどの処理をトリガーとして、あらかじめ定義した処理を自動で実行してくれます。

Workflowの準備

プロジェクトの直下に.github/workflowsというフォルダを作成し、そのフォルダ内にworkflowの内容を記述したファイルを作成していきます。(※ファイルはYAML形式で記述します)
試しに「main.yml」で作成します。

main.yml
# ワークフローの名前
name: sample workflow

# ワークフローを実行するトリガー
on: 
  push: 
    # mainブランチにpushしたとき
    branches: ["main"] 
  pull_request:
    # 新しくmainブランチでpull requestが作成されたとき
    branches: ["main"]
  # 明示的に実行ボタンを押したとき
  workflow_dispatch: 

# ワークフローで実行される一連の処理
jobs:
  # ジョブの一つ
  build:
    # どのような仮想環境でジョブの処理を動かすを定義
    runs-on: ubuntu-latest

    # 処理のステップ
    steps:
      # 外部で定義されたアクションを呼び出している
      # actions/checkout@v3は自分自身のリポジトリのデータを読み込む
      - uses: actions/checkout@v3

      - name: Run a one-line script
        run: echo start build

      - name: Run a multi-line script
        run:
          echo Add other actions to build,
          echo test, and deploy your project.

作成したmain.ymlをリモートブランチにpushしたら、GitHub > Actionsのところで設定した処理を実行してくれます。

おわりに

GitHub Actionsを使えば、テストコードの実行やデプロイ作業の自動化もできます。
今後GitHubで開発することがある場合はぜひGitHub Actionsを使ってみてください!

Discussion