GitHub ActionsでPythonスクリプトを実行する

スポンサーリンク

GitHub ActionsでPythonスクリプトを実行してみます。

■PC環境

>Windows 10

■GitHubでリポジトリを新規作成する

GitHub Actionsを利用してみますが、その前にGitHubでリポジトリを新規作成します。

Webブラウザを起動し、GitHub(https://github.com/)にアクセスし、お持ちのアカウント情報(ユーザー名かメールアドレス,パスワード)でログインを行います。ログインすると管理画面が表示されますので、こちらの画面の右上に「+」ボタンがありますので、このボタンをクリックします。

クリックするとプルダウンメニューが表示されますので、メニューから「New repository」をクリックします。

クリックすると「Create a new repository」が表示されます。こちらで「Owner」の確認を行い、「Repository name」を入力します。今回は「python_script」とします。

次に「Description (optional)」で説明文を入力しますが、今回は入力しませんので、次に「Public」か「Private」を選択しますが、今回は「Public」を選択します。

選択後、ページ下に移動し「Initialize this repository with:」の項目を設定しますが、今回はデフォルトとままで、変更はなしにします。その後「Create repository」ボタンをクリックします。

クリックすると、新しいリポジトリが作成されました。

■GitHub Actionsの設定を行う

作成後、GitHub Actionsの設定を行います。

設定を行いますので、新しく作成したリポジトリの「Actions」タブをクリックします。

クリックすると、「Get started with GitHub Actions(GitHub Actions を使ってみよう)」というActionsのページが表示されます。ページ内の項目に「Suggested for this repository(このリポジトリへの提案)」があり、その中に「Simple workflow」があります。この「Simple workflow」の「Configure(設定する)」ボタンをクリックします。

■ワークフローの設定をする

クリックすると、「blank.yml」というymlファイルの編集画面が表示されます。編集画面内には「This is a basic workflow to help you get started with Actions(Actionsを使い始めるための基本的なワークフローです。)」と記載されていますので、ワークフローを設定していきます。

■コード

# This is a basic workflow to help you get started with Actions

name: Python script

# Controls when the workflow will run
on:
  # Allows you to run this workflow manually from the Actions tab
  workflow_dispatch:

# A workflow run is made up of one or more jobs that can run sequentially or in parallel
jobs:
  # This workflow contains a single job called "build"
  build:
    # The type of runner that the job will run on
    runs-on: ubuntu-latest

    # Steps represent a sequence of tasks that will be executed as part of the job
    steps:
      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
      - uses: actions/checkout@v3

      # Runs a single command using the runners shell
      - name: Run a Python script
        run: python .github/workflows/example.py

ワークフローは上記のように設定します。

なお、「blank.yml」というymlファイルは「script.yml」というファイル名に変更します。

変更後、「Start commit」ボタンをクリックします。

クリックすると、フォームが表示されます。このフォーム内の「Create ****.xml」の入力欄に、今回は「create github action workflow file」と入力します。

入力後、「Commit new file」ボタンをクリックします。

クリックすると、新しいファイルがGitに登録されます。

■スクリプトファイルの作成

登録後、今度はPythonのスクリプトファイルを作成します。

作成後、「workflows」内にスクリプトファイルを作成しますので、「Add file」ボタンをクリックします。

クリックすると、プルダウンメニューが表示されますので、「Create new file」をクリックします。

■コード

def main():
	print("こんにちは、世界。こちらはバーチャル側にいます。")
	
if __name__ == '__main__':
	main()

クリックすると、新しいファイルの編集画面が表示されますので、コードを記述します。今回は上記のdef文を用いてmain()関数を定義し、それを呼び出すようにするコードを記述します。

記述後、ファイル名をワークフローで設定したスクリプトのファイル名である「example.py」とします。

ファイル名を設定後、ページ下に移動すると、「Commit new file」というフォームがあるので、今回は「Create ****.py」の入力欄に「add example.py」と入力し、「Commit directly to the main branch.(メインブランチに直接コミットする)」を選択した状態で「Commit new file」ボタンをクリックします。

クリックすると、PythonのスクリプトファイルがGitに登録されます。

登録後、「Actions」タブをクリックします。

クリックすると、「Actions」のページが表示されますので、ページ内の「Python script」をクリックします。

クリックすると、「This workflow has a workflow_dispatch event trigger.(このワークフローには、workflow_dispatch イベントトリガーがあります。)」と表示された右側に「Run workflow」ボタンがありますので、こちらをクリックします。

クリックすると、「Use workflow from」と表示された欄が表示されます。この欄の中で「Branch: main」の設定にしたままで、「Run workflow」ボタンをクリックします。

クリックすると、「This workflow has no runs yets.(このワークフローはまだ実行されていません。)」と表示されたままですが、再度「Python script」をクリックします。

クリックすると、今度は「This workflow has no runs yets.(このワークフローはまだ実行されていません。)」という表示はされず、「Python script」が追加されます。この追加された「Python script」をクリックします。

クリックすると、ワークフローの詳細が表示されます。表示された詳細の「build」をクリックします。

クリック後、「build」の「Run a Python script」をクリックすると、GitHub ActionsでPythonスクリプトを実行し、実行された結果が出力されていることが確認できました。

コメント

タイトルとURLをコピーしました