【初心者向け】GitHub Actionsの仕組みをエンジニアが解説！

この記事は…

GitHub Actionsで何が出来るかをざっくり解説
試しにサーバーに対してActionを実行する手順を紹介
サンプルコード有り

GitHub Actions について
1. まず何が出来るのか
2. 仕組み
設定（実装）手順
1. ymlファイルを作成
  1. コードの解説
2. 環境変数を設定する
GitHub Actions を動かしてみる
1. 想定
2. いざpush
まとめ

GitHub Actions について

まず何が出来るのか

GitHub Actionsというものを知ったときに、真っ先に考えるのがコレですよね。

結論から言うと、だいたいのことは何でも出来ます！
※コードが書ければね。

ということで詳しく解説していきます。

仕組み

上の図は１例ですが、Gitに対する何かしらのアクション(pushなど)をトリガーにして、任意のコマンドを実行できる、これが GitHub Actions です。

任意のコマンドとは、リポジトリ毎にyml形式のファイルを作成し、そこに記述したものが実行される仕組みです。

CI/CD に用いられることが多いイメージですね。

例えば mainブランチへのpushをトリガーに、サーバー側へ以下のコマンド発行を命令します。

git pull
マイグレーションなどの実行
アプリケーションプロセスの再起動

この仕組みで、開発者は mainブランチへpushしただけで、あとは自動でデプロイが進むんです！

設定（実装）手順

ymlファイルを作成

今回の GitHub Actions は、mainブランチへのpushをトリガーにしたいと思います。

まず最初に、任意のブランチを作成し、以下のようにymlファイルを作成します。

.github/workflows/任意の名称.yml

name: "CICD test"
on:
  push:
    branches: [ "main" ]
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v3
    - name: Deploy
      env:
        PRIVATE_KEY: ${{ secrets.PRIVATE_KEY }}
        USER_NAME: ${{ secrets.USER_NAME }}
        HOST_NAME: ${{ secrets.HOST_NAME }}
      run: |
        echo "$PRIVATE_KEY" > private_key && chmod 600 private_key
        ssh -o StrictHostKeyChecking=no -i private_key ${USER_NAME}@${HOST_NAME} 'cd the-app &&
        git pull origin main
        touch log/ga-$(git rev-parse --short HEAD)'

もうお気づきの方もいるかもしれませんが、run句の箇所で”ssh”や”git”などのコマンドを書いています。

つまり、これがActionとして実行される訳なんです。
（他の色々なコマンドも実行可能なので、割となんでも出来てしまうんですよね）