📘

[CircleCI] ローカルでCircleCIを使いたい

2021/05/02に公開

ローカルでcircleciを使いたい

circleciって始めたばかりだとconfig.ymlって中々通らないですよね。特に最初は「コミットして確かめる。」なんて対応をしている人もいるんじゃないでしょうか。

ローカルにcircleciを導入すれば試しながらconfig.ymlを修正できそうなので導入することにします。

インストール・設定

前提

  • Mac
  • Docker導入済み
  • Github,CircleCIのアカウント作成、連携済み

homebrewでインストール

せっかくhomebrewを入れているのでbrewでインストールすることにします。

すでにdockerを導入しているなら、--ignore-dependenciesをつけろということなのでそうします。

brew install --ignore-dependencies circleci

トークンの取得

CLIでWebサービスを使う時のお決まりですが、その設定をします。

https://app.circleci.com/settings/user/tokensにアクセスしてトークンを発行します。「Create New Token」をクリックして、

「Token Name」を入力します。なんて名前入れれば分かりやすいか、パッと思いつかなかったので「LOCAL_CLI」とでもしておきましょう。

最後にトークンをコピーしておきます。

ここでコピーし忘れたままcloseすると、もう確認できないのでこの後のセットアップを行なってからcloseするのがおすすめです。

トークンの設定

今度はローカルに戻ってコマンドが使えるようにセットアップします。

circleci setup

このコマンドを実行したら、APIトークンを聞かれるので先ほどコピーしたものをペーストします。

次に、CircleCIを使用するホストを聞かれますが、デフォルトでhttps://circleci.comに指定がされているのでそのままEnterでOKです。

以上で基本的な設定は完了です。

使ってみる

せっかくなのでつかってみましょう。

CircleCIの導入自体も中々のボリュームになるなのでそれ自体はこの記事で解説しません。

まずは、CircleCIを既に導入しているプロジェクトに移動します。

設定ファイルのバリデーション

設定ファイルのバリデーションをみることもできます。

circleci config validate

ジョブを実行する

これが大本命ですね。これでjobを実行できるので、試し放題?

circleci local execute --job ジョブの名前
circleci local execute --job build

これ以外にもできることがある

私自身CircleCI初心者ということもあり、全然使いこなせてない感がありました。公式が結構丁寧なのでそちらも参照してください。

参考サイト

ここまでの手順は基本的に公式を参考にしています。

https://circleci.com/docs/ja/2.0/local-cli/

Discussion