こんにちは、カスタマーサクセスのチヨです。
最近猫を飼い始めたのですが、夜泣きがひどく寝不足が続いています。
夜泣き一発解消グッツなどありましたら、ぜひ教えてください。
さて今回は先日GAになったVS Codeを共有させていただきます。
コードエディターとしてVS Codeを使用しているエンジニアの方ににぜひ今回の拡張機能をご利用いただきたいです。今回の新機能によりVS Codeから画面を切り替えることなくCircleCIを操作できるようになります。
役割としては以下二つの機能があります：
パイプラインマネージャー: CircleCI パイプライン、ワークフロー、ジョブを VS Code で直接表示および管理できます。
コンフィグヘルパー: VS Code 内で CircleCI YAML ファイルの作成、編集、最適化を容易に行うことができ、常にドキュメントを参照する必要がありません。
Visual Code Studio設定方法
-
Marketplaceから無料でCircleCIをダウンロードします。
-
CircleCIのページからトークンを発行します。(https://app.circleci.com/settings/user/tokens)
-
発行したトークンをVS Codeの設定画面に登録します。
-
プロジェクトのパイプラインの設定をしていきます。
トークン登録の下の画面にパイプラインの設定ができます。どのパイプラインを可視化するのかを選択してください。
- １つのプロジェクトを選ぶか、circleci/config.yml のファイルがある場合自動的に感知される
- 自分のパイプラインか、他の人の書いたパイプラインか選べる
- 全てのブランチか、自分の現在のものだけ
- パイプラインのステータスを選択したジョブや、workflowも選択可能
どのイベントで通知設定したいか選択
- workflowのステータス変更 (Workflowが失敗した際に通知を受ける、成功の際は通知なしなど。Approve待ちなど)
パイプラインパネル
設定完了後ビルドを走らせてみると左側のステータスページにて直近のworkflowが表示されます。re-run workflowや失敗したジョブを確認できます。
コンフィグヘルパー
コンフィグヘルパーではYAMLを書く、編集する、トラブルシュートをする際に役立つ以下の機能があります：
Auto-completion
Syntax validation
Syntax highlighting
On-hover documentation
Warnings
Usage hints
Reference/definition navigation
Syntax highlighting
属性によって色分けしているため、編集のスピードが短縮できます。
On-hover documentation
〜の上をホバーリングすると注意書きが表示される機能です。
YAML上で新しいイメージがリリースされているその場で表示されます。
そのほか、store_test_resultなど推奨される列に表示される。
Syntax validation
スペリングミスや、列のずれを指摘
Auto-completion
次に入りそうな文字や文を予測で候補を表示しています。
Reference navigation/definition
Configファイルが膨大な量の際に、ジョブやステップに 参照をつけることができます。
最後に
現在GitLabをお使いのお客様は、こちらの機能を使用するとこはできません。
こちらの機能につきましてフィードバックなどありましたら、cci-vscode-feedback@circleci.comへご連絡ださい。