Hello World

このページでは、 ユーザー登録後に CircleCI で Linux、Android、Windows、macOS プロジェクトの基本的なビルドを開始するための方法について解説しています。

この例では、 Node 用のビルド済み CircleCI Docker イメージを実行するコンテナをスピンアップする build というジョブを追加してから、 echo コマンドを実行します。 echo コマンドを実行します。 まずは以下の手順を行います。

1. GitHub または Bitbucket のローカル コード リポジトリのルートに、.circleci というディレクトリを作成します。

2. 以下の行を含む config.yml ファイルを作成します (CircleCI Server v2.x をご利用の場合は、version: 2.0の設定を使用してください)。

   version: 2.1
   jobs:
     build:
       docker:
         - image: cimg/node:17.2.0 # ジョブのコマンドが実行されるプライマリ コンテナ
           auth:
             username: mydockerhub-user
             password: $DOCKERHUB_PASSWORD  # コンテキスト/プロジェクト UI 環境変数を参照します
       steps:
         - checkout # プロジェクト ディレクトリ内のコードをチェックアウトします
         - run: echo "hello world" # `echo` コマンドを実行します
   

3. 変更をコミットし、プッシュします。

4. CircleCI アプリの Projectページにアクセスし、プロジェクトの隣にある Set Up Project ボタンをクリックします。 プロジェクトが表示されない場合は、そのプロジェクトが関連付けられている組織が選択されているかどうかを確認してください。 その方法は、下記の 組織の切り替えのセクションでご確認ください。

5. ステップに従ってプロジェクトのconfig.yml ファイルを設定し、はじめてのパイプラインをトリガーします。

Workflow のページに build ジョブが表示され、コンソールに Hello World と出力されます。

ヒント: No Config Found エラーが発生した場合、.yaml ファイル拡張子を使用している可能性が考えられます。 このエラーを解決するには、ファイル拡張子として .yml を使用してください。

CircleCI は、各 ジョブをそれぞれ独立した コンテナまたは VM で実行します。 つまり、ジョブが実行されるたびに、CircleCI がコンテナまたは VM をスピンアップし、そこでジョブを実行します。

サンプルプロジェクトについては、 Node.js の JavaScript チュートリアルを参照してください。

Linux と Android の例と基本的に変わらず、macos Executor およびサポートされているバージョンの Xcode を使用するジョブを追加します。

jobs:
  build-android:
    docker:
      - image: cimg/android:2021.10.2
        auth:
          username: mydockerhub-user
          password: $DOCKERHUB_PASSWORD  # context / project UI env-var reference

詳細とサンプル プロジェクトについては、 Android 言語ガイドを参照してください。

基本的な内容は上記の Linux のサンプルと同じで、macos Executor およびサポートされているバージョンの Xcode を使用するジョブを以下のように追加します。

jobs:
  build-macos:
    macos:
      xcode: 12.5.1

詳細とサンプルプロジェクトについては、 macOS での Hello World を参照してください。

基本的な内容は上記の Linux のサンプルと同じで、Windows Executor を使用するジョブを以下のように追加します。 クラウド版では、Orb とversion: 2.1 設定を使用する必要があります。

version: 2.1 # バージョン 2.1 を指定して Orb の使用を有効化します

orbs:
  win: circleci/windows@4.1.1 # Windows Orb には Windows Executor の使用に必要なすべてが揃っています

jobs:
  build: # ジョブの名前
    executor:
      name: win/default # executor type
      size: "medium" # resource class, can be "medium", "large", "xlarge", "2xlarge", defaults to "medium" if not specified

    steps:
      # コマンドは仮想マシン環境で実行されます
      - checkout
      - run: Write-Host 'Hello, Windows'

version: 2.1

jobs:
  build: # name of your job
    machine:
      image: windows-default # Windows machine image
    resource_class: windows.medium
    steps:
      # Commands are run in a Windows virtual machine environment
        - checkout
        - run: Write-Host 'Hello, Windows'

version: 2

jobs:
  build: # ジョブの名前
    machine:
      image: windows-default # Windows マシン イメージ
    resource_class: windows.medium
    steps:
      # Windows 仮想マシン環境で実行するコマンド
        - checkout
        - run: Write-Host 'Hello, Windows'

Orb は、構成を簡略化したりプロジェクト間で再利用したりできる、便利な構成パッケージです。 CircleCI Orb レジストリで参照できます。

プッシュする新しいプロジェクトを自動的にフォローすることで、メール通知が届き、プロジェクトがダッシュボードに追加されます。 CircleCI アプリケーションで組織を選択し、手動でプロジェクトをフォローまたはフォローを停止することもできます。 サイドバーで Projects をクリックし、フォローを開始または停止するプロジェクトの横にあるボタンをクリックします。

CirlceCI の画面左上に、組織を切り替えるメニューがあります。

プロジェクトが表示されなかったり、目的のビルドではないものが表示される場合は、画面左上にある組織名を確認してください。 たとえば、左上にユーザー my-user が表示されている場合、my-user に所属する GitHub プロジェクトのみが使用可能です。 GitHub プロジェクト your-org/project を追加する場合は、組織の切り替えタブから your-org を選択する必要があります。

• 2.0 設定ファイルの概要、および .circleci/config.yml ファイルにおけるトップレベル キーの階層については「 コンセプト」を参照してください。

• 並列実行、順次実行、スケジュール実行、手動承認のワークフローによるジョブのオーケストレーションの例については「 ワークフローを使用したジョブのスケジュール」を参照してください。

• すべてのキーとビルド済み Docker イメージに関する詳細なリファレンスについては、それぞれ「 CircleCI を設定する」、「 CircleCI のビルド済み Docker イメージ」を参照してください。