GitHub ActionsのVS Code拡張の提供が開始されました(公開ベータ版)

2023.03.29

この記事は公開されてから1年以上経過しています。情報が古い可能性がありますので、ご注意ください。

こんにちは、CX事業本部 Delivery部の若槻です。

このたびのアップデートにより、GitHub Actions VS Code extensionが公開ベータとなりました。

下記のextensionを使うことにより、GitHub Actions workflowの管理をVS Code上で行うことができるようになります。

試してみた

VS Codeへのインストール

マーケットプレイスからextensionをVS Codeにインストールします。

サイドバーにGitHub Actionsのアイコンが追加されます。GitHubへのサインインを求められるので、サインインします。

サインイン後に[Refresh]ボタンが表示されるので、クリックします。

するとNo GitHub repositories found. Please open a folder that contains a GitHub repository.と表示されました。

GitHub repositoryが含まれたフォルダーをVS Codeで確かに開いているのですが認識されていないようです。

この場合はVS Codeのウィンドウを閉じて、再度開くと認識されました。現在のrepositoryで管理しているworkflowの情報が表示されていますね。

Workflow実行履歴の確認

[WORKFLOWS]では実行履歴を確認することができます。ツリーをドリルダウンするとジョブやステップごとのステータスまで確認できます。

Workflow実行名右の[Open workflow run]をクリックすると、Workflow実行をブラウザで開くことができます。

またジョブ名右のボタンをクリックすると、ジョブのログをVS Code上で確認することができます。

Workflow設定の管理

[SETTINGS]ではGitHub Actionsが利用するEnvironments、SecretsおよびValiablesの設定を管理できます。

Valiablesの追加を試してみます。[Add new variable]をクリック。

プロンプトで名前の入力を求められるので、適当な名前を入力します。Enterキーを押すと、値を入力する画面に遷移します。

プロンプトで値を入力しEnterキーを押します。

入力した名前及び値でVariablesが追加されました。

ブラウザでRepositoryのSettingsを開き、[Variables]を開くと、VS Code上で追加した変数が追加されていることが確認できます。

Workflowの編集支援

Workflowファイルの編集における支援機能も提供されています。

スキーマに対するサジェストが行われるようになります。

SecretsやVariablesの場合は利用可能な一覧をサジェストしてくれます。

また構文の静的解析を行い、不正な場合はバリデーションエラーを表示します。

おわりに

GitHub Actions VS Code extensionが公開ベータとなったのご紹介しました。

ブラウザでGitHub Actionsの画面を開かなくても、workflowの実行状況の確認や設定ができるのは便利ですね。是非とも入れておきたい拡張機能です。

参考

以上