Hello World

1+ year ago1 min read
Last updated • Read time
クラウド
This document is applicable to CircleCI クラウド
Server v4.x
This document is applicable to CircleCI Server v4.x
Server v3.x
This document is applicable to CircleCI Server v3.x

ここでは、任意の実行環境を使って基本的なパイプラインの操作を始める方法を紹介します。 このページに記載されている手順は、新しいプロジェクトをローカルで作成し、変更内容をお使いの VCS に Git を使ってプッシュすることを前提としています。 また、CircleCI への ユーザー登録 がお済みであることも前提としています。

すでに CircleCI に "プラグイン" するリポジトリをお持ちの場合は、設定ファイルのコミットを含め、すべて CircleCI Web アプリ内で設定できます。 このフローについては、 クイックスタートガイド の概要を参照してください。

Server v4.x での Echo hello world

この例では、hello world をコンソールに出力する hello-job というジョブを追加します。 まずは以下の手順を行います。

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

  2. 作成した .circleci ディレクトリから config.yml ファイルを作成し、次の内容を追加します (タブを使用して実行環境を選択)。

    ジョブ hello-job は、 ノード用のビルド済み CircleCI Docker イメージ を実行するコンテナをスピンアップします。 詳細については、 Docker 実行環境の使用 のページを参照してください。

    version: 2.1
    
    jobs:
      hello-job:
        docker:
          - image: cimg/node:17.2.0 # the primary container, where your job's commands are run
        steps:
          - checkout # check out the code in the project directory
          - run: echo "hello world" # run the `echo` command
    
    workflows:
      my-workflow:
        jobs:
          - hello-job
  3. 変更内容を VCS にコミットしてプッシュします。

  4. CircleCI Web アプリの Projects ページにアクセスし、新しいプロジェクトの隣にある Set Up Project ボタンをクリックします。 プロジェクトが見つからない場合は、Web アプリの画面左上で正しい組織が選択されているかどうかを確認してください。 詳細については、 組織の切り替え を参照してください。

  5. ポップアップの手順に従って、最初のパイプラインをトリガーするために、作成した config.yml ファイルを使用することを CircleCI に指示します。 hello-job までクリックし、echo "hello world" ステップを選択すると、`hello world がコンソール表示されます。

    ジョブステップ出力内に hello world が表示されたスクリーンショット

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

Server v3.x での Echo hello world

この例では、hello world をコンソールに出力する hello-job というジョブを追加します。 まずは以下の手順を行います。

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

  2. 作成した .circleci ディレクトリから config.yml ファイルを作成し、次の内容を追加します (タブを使用して実行環境を選択)。

    ジョブ hello-job は、 ノード用のビルド済み CircleCI Docker イメージ を実行するコンテナをスピンアップします。 詳細については、 Docker 実行環境の使用 のページを参照してください。

    version: 2.1
    
    jobs:
      hello-job:
        docker:
          - image: cimg/node:17.2.0 # the primary container, where your job's commands are run
        steps:
          - checkout # check out the code in the project directory
          - run: echo "hello world" # run the `echo` command
    
    workflows:
      my-workflow:
        jobs:
          - hello-job
  3. 変更内容を VCS にコミットしてプッシュします。

  4. CircleCI Web アプリの Projects ページにアクセスし、新しいプロジェクトの隣にある Set Up Project ボタンをクリックします。 プロジェクトが見つからない場合は、Web アプリの画面左上で正しい組織が選択されているかどうかを確認してください。 詳細については、 組織の切り替え を参照してください。

  5. ポップアップの手順に従って、最初のパイプラインをトリガーするために、作成した config.yml ファイルを使用することを CircleCI に指示します。 hello-job までクリックし、echo "hello world" ステップを選択すると、`hello world がコンソール表示されます。

    ジョブステップ出力内に hello world が表示されたスクリーンショット

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

次のステップ

  • CircleCI 固有のコンセプトのサマリーについては、 コンセプト のページを参照してください。

  • 同時実行、順次実行、スケジュール実行、手動承認の各ワークフローによるジョブ実行のオーケストレーションの例については、 ワークフロー に関するページを参照してください。

  • すべてのキーと実行環境の完全なリファレンス情報については、 CircleCI 設定のリファレンス に関するページでご確認いただけます。