VSCodeにGitHub Actionsの公式拡張がリリースされたので試してみた
概要
CI/CD構築を可能にするGitHub ActionsのVSCode拡張機能が public bata版として発表されました。
使ってみた
インストール
VSCodeの機能拡張のサイドバーで検索、または下記リンクからインストールすることが可能です。
設定
使用するにはVSCodeでGitHubへのサインインを行っておく必要があります。 （サイドバーのタブを開くとサインインを求められると思います）
できること
① シンタックスハイライトとサジェストが効く
GitHub Actions独自の文法形式のハイライトが効くようになっています。
またGitHub Actionsのコンテキスト、github.に続くプロパティのサジェストも効きます。
② 説明
先程のコンテキストにカーソルをオーバーフローすると、そのコンテキストの詳細説明が表示されます。
${{ github.actor }}について
The username of the user that triggered the initial workflow run. If the workflow run is a re-run, this value may differ from github.triggering_actor. Any workflow re-runs will use the privileges of github.actor, even if the actor initiating the re-run (github.triggering_actor) has different privileges.
③ 文法のバリデーションが効く
例えばjobs配下に定義するruns-onをあえてtypoしてみると下記のようにエディタ上に警告と、PROBLEMSタブに
- Required property is missing: runs-on（必須項目の
runs-onが欠けています） - Unexpected value 'runs-ons'（
runs-onsという不明な値が記載されています）
といった詳細なエラー原因と箇所を出力してくれます。
④ ワークフローの一覧や履歴を確認できる・Runの再実行が可能
workflowsエリアで定義されているActionsの一覧と実行履歴を確認することができます。
また、VSCode上から再実行をすることが可能です
⑤ GitHub EnvironmentsやGitHub Secrets・GitHub Variablesの設定値の追加や参照が可能
SETTINGSエリアで実現可能です
新規追加する際は、VSCode上でフォームが出現します。
GitHub Environments
環境自体はGitHubサイト上でしか新規登録できなさそうでした。 登録されているEnvironmentがあれば、その配下のSecretsやVariablesの値を追加、参照できます。（Secretsのvalueは見えない）
リポジトリのSecrets
Secretsの値を追加、参照可能です。（Secretsのvalueは見えない）
リポジトリのVariables
Variablesの値を追加、参照可能です。
おわりに
今回はVSCodeでGitHub Actionsの公式拡張がリリースされたので、試して実現可能になっていたことを書きました！
今までGitHub Actionsの公式ドキュメントを調べながらコンテキストの内容を探り探り書いていましたが、サジェストが効くことでどの選択肢があるかすぐに分かるようになりました。
また、実際にActionsを動かしてみて気づくしかなかった文法エラーも、警告してくれるようになり、作業効率が大幅に上がると思います。
GitHub上でしか見ることができなかったRunの一覧や設定情報もVSCodeで確認できるようになり、またRunの再実行や設定値の追加更新ができるようになり、とても便利になったと思います！
