Github Actions超入門

はじめに

なんとなくgithubを使っていると、リポジトリの上の方にいるこいつ。

いつも目につくけど、一体なんなんだろう？

そう思いながら放置してきた方に向けたGithub Actionsの入門です。

GitHub Actionsとは

GitHub Actionsは、Githubが提供しているワークフロー自動化ツールです。Githubのユーザーであればすぐに利用できます。

詳細はこちら...

色々書いてありますが、要はテストとかを自動でできちゃいます！という便利なものです。
なんだか難しそうですが...実は簡単に使えてしまうわけです。

前提

• Githubに登録しており、基本的な設定が完了している

今回は簡単なPythonのプログラムを例として用いるので、ローカルでPythonが実行できることが望ましいです。（実行結果などは下記で紹介していますのでPythonの実行環境がなくても問題はないです！）

手順

1. プログラムを用意する

まずはリポジトリを作成しましょう。
main.pyを作成します。

main.py

import sys

def main():
    if len(sys.argv) > 1 and sys.argv[1] == "bye":
        print("Good Bye...")
    else:
        print("Hello World")

if __name__ == "__main__":
    main()

今回は上記のプログラムを例として扱います。
実行するとこんな感じです。

$ python main.py
Hello World

$ python main.py bye
Good Bye...

そのまま実行するとHello Worldを出力し、引数でbyeを指定するとGood Bye...を出力します。
とんでもなく雑ですが許してください。
動作が確認できたら保存してpushしておきます。

2. Actionsの設定をする

リポジトリのActionsに移動します。

何やらいっぱいありますが、とりあえず全部無視してset up a workflow yourselfをクリックします。

エディタが立ち上がりました！
下記のコードをコピペします。

main.yml

name: Python application test

on:
  push:
    branches:
      - master

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
    - name: Set up Python 3.x
      uses: actions/setup-python@v3
      with:
        python-version: '3.x'

    - name: Test with default argument
      run: python main.py

    - name: Test with argument 'bye'
      run: python main.py bye

Commit changeしちゃいましょう！

ではActionsのタブに戻って見てみましょう！

何やら動いてますね。

Create main.ymlに行ってみます。

buildをクリックして...

Testの部分を開いてみると上手く実行できていますね！

これであなたはもうGithub Acionsを使えるようになってしまいました...

はい、とまあこんな感じで簡単な流れの紹介でした。
もっと興味がある方は、最初の方で紹介した公式のリファレンスを見ていただくのがいいかなと思います。