ワークフローの作成
GitHub Actions の最初のワークフローとして、リポジトリをクローンして Hello World を出力する簡単な定義を作成します。
1. GitHubのコードのclone
GitHubで作成した github-actions-test のリポジトリをローカル環境にcloneします。ここからはGitコマンドを使って進めます。
まず、Windowsの場合はコマンドプロンプトを、Macの場合はターミナルを開きます。
以下のコマンドで、Git がインストールされていることを確認します。
git --version
以下のように Git のバージョンが表示されれば、インストールは確認できています。
git version 2.x.x
バージョンが表示されない場合は、Git/GitHubのセットアップ を先に実施してください。
インストールが確認できたら、以下のコマンドを実行してGitHubのリポジトリをダウンロードします。フォルダの場所を指定したい場合は、事前に cd コマンドで移動してから実行してください。また、<your-github-account-name> の部分はご自身のGitHubアカウント名に置き換えます。
git clone https://github.com/<your-github-account-name>/github-actions-test.git
コマンドが成功すると、以下のように正常終了のメッセージが表示されます。
なお、You appear to have cloned an empty repository. という警告が出る場合がありますが、これは「リポジトリにまだ何も入っていない」という意味です。今回はまだファイルを作成していないため、想定どおりの状態です。
Cloning into 'github-actions-test'...
warning: You appear to have cloned an empty repository.
2. ワークフローファイルの作成
ここからはVisual Studio Codeを使って、ワークフローのファイルを作成します。
Visual Studio Codeを起動すると、最初に[ようこそ]の画面が表示されます。左上にあるファイルのアイコンをクリックし、フォルダを開くを選びます。フォルダの選択画面が表示されるので、先ほどgit cloneしたgithub-actions-testのフォルダを選択します。
github-actions-testのフォルダが開きました。
ここに、GitHub Actionsのワークフローを記述するためのgithub-actions-test.ymlファイルを作成します。GitHub Actionsでは、.github/workflowsフォルダの中に配置したymlファイルがワークフローとして認識されます。
左側のエクスプローラでファイルのアイコンをクリックします。
ファイル名として .github/workflows/github-actions-test.yml と入力します。これにより、.githubフォルダとworkflowsフォルダ、そしてgithub-actions-test.ymlファイルが順に作成されます。
github-actions-test
└── .github
└── workflows
└── github-actions-test.yml ← このファイルを作成
github-actions-test.ymlファイルが作成されました。
なお、Visual Studio Codeの設定によっては、ファイル名が赤く表示されることがあります。これは、YAMLファイルの中身がまだ空であることを示す警告です。ファイルを作成した直後に表示されるものなので、問題ありません。
3. コードの記載
作成したファイルに以下の内容を記述して保存します。
name: Test Workflow
on:
workflow_dispatch:
jobs:
hello:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v5
- name: list files
run: ls -la
コードを解説します。
name: Test Workflow
nameは、ワークフロー全体の名前を定義しています。ここでは「Test Workflow」という名前が付けられており、GitHub上でもこの名前で実行結果を確認できます。
on:
workflow_dispatch:
onは、ワークフローをどのタイミングで実行するかを指定する部分です。ここではworkflow_dispatchと定義しており、これは「手動実行」を意味しています。
jobs:
hello:
runs-on: ubuntu-latest
jobsは、ワークフロー内で実行されるジョブを定義するブロックです。ここではhelloという名前のジョブを定義しています。runs-onはランナーを表し、ジョブをどの環境で実行するかを指定します。ここではubuntu-latestとなっており、GitHubが用意している最新のUbuntu環境で実行されます。
steps:
- name: Checkout repository
uses: actions/checkout@v5
stepsは、ジョブの中で実行される処理の手順を定義します。1つ目のステップでは、actions/checkout@v5というアクションを使用して、現在のブランチのコードをUbuntuの実行環境にダウンロードします。なお、手動実行の場合は、実行時にどのブランチを対象にするかを選択することができます。
- name: list files
run: ls -la
2つ目のステップでは、runでLinuxコマンドのls -laを実行し、カレントディレクトリのファイルを一覧表示します。今回のワークフローではランナーとしてUbuntuを指定しているため、Linuxコマンドを使用できます。
このように、このワークフローはGitHub上から手動で実行すると、Ubuntu環境上で指定ブランチのコードを取得し、そのファイル一覧を出力するだけの、非常にシンプルな処理を行います。
4. テスト用ファイルの記載
続いて、GitHub Actionsの本題とは直接関係ありませんが、テストとしてリポジトリ内のファイル一覧を確認するために、一つファイルを作成しておきましょう。
Visual Studio Codeを使い、README.mdという名前のファイルを作成します。このとき、.github/workflowsフォルダの中ではなく、リポジトリのトップ階層に作成してください。
github-actions-test
├── .github
│ └── workflows
│ └── github-actions-test.yml
└── README.md ← このファイルを作成
5. Gitへの反映
ここまで作成したワークフローのファイルを、GitHubに反映します。 ここからは、Visual Studio Codeのターミナルを使って操作を進めます。
まず、Visual Studio Codeの上部メニューからターミナルを開き、新しいターミナルをクリックします。

画面の下にターミナルが表示されます。ここでGitのコマンドを入力します。
はじめに、git add . と入力して、変更したファイルをインデックスに追加します。
git add .
このコマンドを実行しても、特に表示はありませんが問題ありません。
次に、git commitコマンドで変更内容をコミットします。
git commit -m "github actions test"
このように実行すると、2 files changed といった結果が表示されます。
2 files changed, 12 insertions(+)
create mode 100644 .github/workflows/github-actions-test.yml
create mode 100644 README.md
続いて、git pushコマンドでGitHubに反映させます。
git push origin main
正常に完了すると、送信結果のログが表示されます。
Enumerating objects: 7, done.
Counting objects: 100% (7/7), done.
Delta compression using up to 8 threads
Compressing objects: 100% (4/4), done.
Writing objects: 100% (7/7), 620 bytes | 620.00 KiB/s, done.
Total 7 (delta 0), reused 0 (delta 0), pack-reused 0 (from 0)
To https://github.com/<your-github-account-name>/github-actions-test.git
[new branch] main -> main
| ⚠️ 「Authentication failed」エラーが出る場合 |
|---|
| GitHubへの認証に失敗しています。HTTPSでcloneした場合、Personal Access Token(PAT)が必要です。 GitHubの「Settings」→「Developer settings」→「Personal access tokens」からトークンを作成し、パスワードの代わりに使用してください。 |
| ⚠️ 「failed to push some refs」エラーが出る場合 |
|---|
リモートリポジトリに変更があり、ローカルと同期がとれていません。git pull origin mainを実行してから、再度git pushを試してください。 |
最後に、GitHubの画面を開いてみましょう。github-actions-testリポジトリを開くと、今コミットしたファイルが反映されていることが確認できます。
