GitHub Actions VSCode 拡張の紹介

はじめに

2023-03-29 に public beta となったため、VSCode に早速インストールして使ってみた。今回は試してみたことをメモがてら残しておく。公式のブログは以下を参照してもらえればと思う。

Announcing the GitHub Actions extension for VS Code

Today, we’re excited to announce the release of the public beta of the official GitHub Actions VS Code extension, which provides support for authoring and editing workflows and helps you manage workflow runs without leaving your IDE.

github.blog

ワークフローの管理

VSCode 拡張を入れて、左側の GitHub Actions のアイコンをクリックすると、まずワークフローの一覧が確認できる。.github/workflows/*.yaml のファイルごとにまとめられているので見たいファイルのものを選択して広げて詳細を確認できる。

さらに #130 などの部分のアクション id をクリックするとブラウザで action の画面を開き、build などの job 名をクリックすると、VSCode 上でアクションのログを確認できる。

このあたりは、ブラウザと VSCode を行ったり来たりしていたのが少し楽になりそう。

secret の確認と変更

ワークフローの一覧の下には、以下のように secret の一覧が表示されている（値はもちろん確認できない）。GitHub 上でこれまで確認や変更（削除含め）行っていたのが、VSCode 上でも可能となっていた。

公開されている action へのリンク

uses: actions/checkout@v3 など公開されている action を使用している箇所にホバーした際、GitHub リポジトリへのリンクが表示されるようになった！個人的にこれは非常にありがたくて、input の項目を確認する際いつも Google で検索していた手間がなくなったのは嬉しい。

シンタックスハイライト

GitHub Actions の expression にシンタックスハイライトが適用されるようになった。また、ホバーすることでドキュメントへのリンクも対応されている。

それだけでなく、補完機能と構文チェックも実装されている。（ツイートを参照）

参考

「GitHub Actions extension for VS Code」パブリックベータ公開。VSCodeからワークフローの実行と監視、管理が可能に

GitHubは、Visual Studio Codeの拡張機能としてGitHub Actionsによるワークフローの実行や監視、管理を可能にする「GitHub Actions extension for VS Code」のパブリックベータ公...

www.publickey1.jp