Getting Started with Screwdriver

このページでは、Screwdriverを利用して簡単なアプリケーションが短時間でどのようにビルド・デプロイされるか説明します。このページの例ではSCMプロバイダとしてGithubを利用します。

必要なもの

• Githubアカウント

セットアップ

まず最初に、サンプルリポジトリを開発環境にcloneし、そのプロジェクトディレクトリにcdします。この先の例ではgenericについて説明します。

• generic*
• Golang
• Nodejs
• Ruby

$ git clone git@github.com:<YOUR_USERNAME_HERE>/quickstart-generic.git
$ cd quickstart-generic/

Makefileや小さなスクリプトの場合はgenericのscrewdriver.yamlを参照することをお勧めします。

アプリケーションの開発

アプリケーションがセットアップできたので開発を始めることができます。このアプリケーションにより、Screwdriverのビルド内でどのようにMakefileとbashスクリプト(my_script.sh)が実行されるかを確認できます。

screwdriver.yaml

screwdriver.yamlはScrewdriverを利用する際に必要となる唯一の設定ファイルです。このファイルにはアプリケーションの開発、ビルド、デプロイに必要なすべてのステップを定義します。詳細はユーザーガイドの設定セクションをご覧ください。

Shared

sharedセクションは、すべてのジョブに継承される属性を定義する場所です。

今回の例では、全てのジョブは同じ”buildpack-deps”というDockerコンテナで実行されます。通常、imageは”reponame”の形式で定義されます。または、”repo_name:tag_label”の形で定義することができ、”tag_label”にはimageのバージョンが入ります。詳しくはDockerのドキュメントをご覧ください。

# Shared definition block
shared:
  # Source: https://hub.docker.com/r/library/buildpack-deps/
  image: buildpack-deps

Jobs

jobsセクションはそれぞれのジョブで実行するすべてのタスクやstepsが定義される場所です。

Stages

同じ目的のために実行されるジョブの役割を分かりやすくするために、Jobsをグループ化してstageを形成することができます。例えば、CIジョブはインテグレーションとして、CDジョブはデプロイメントとしてグループ化することができます。ステージは1つ以上のジョブを含むことができますが、1つのジョブは1つのステージにだけ属することができます。

Workflow

requiresキーワードはジョブが実行される順序を示します。requiresには単一のジョブ名もしくは配列で複数のジョブ名を指定します。~prや~commitといった特別なキーワードを指定した場合にはそれぞれ特定の Git イベントが発生した時に実行されます。

• requires: ~pr はプルリクエストがオープンされた時にジョブが実行されます。同じプルリクエストにコミット/プッシュがされると、再実行されます。
  • PRワークフローでは、ステージ設定は現在サポートされていません。
• requires: ~commit はSDの設定ブランチにプルリクエストがマージされたり、直接コミット/プッシュがされた時にジョブが実行されます。UIから Start ボタンが押されたときにも実行されます。

Steps

stepsセクションは、実行されるコマンドのリストが定義される場所です 。それぞれのステップは”step_name: command_to_run”の形で定義します。”step_name”は自身を参照するわかりやすいラベルです。 “command_to_run”はこのステップで実行される1つのコマンドです。ステップの名前は頭にsd-がつくものは設定できません。これは、Screwdriverのステップとして予約語になっているからです。同じジョブであれば、環境変数はステップ間で受け渡しすることができます。基本的に、Screwdriverはターミナルで/bin/shを実行します。稀に、異なるターミナルやシェルを使用する場合、予期せぬ振る舞いをする可能性があります。

例えば、 “main” ジョブは簡単な1行のシェルコマンドを実行する例を示します。最初のステップ(export)は環境変数 GREETING="Hello, world!"をセットしています。2番目のステップ(hello)では、1ステップ目でセットした環境変数を出力しています。3番目のステップではmetadata(ビルドに関連する情報を格納するキーバリュー型のデータストア)に任意のキーで値を設定しています。ここで設定した値は”second_job”の中で取得しています。

また、 “second_job” という別のジョブを定義しています。このジョブでは別のコマンドセットを実行します。 “make_target” ステップではMakefileターゲットを呼び、いくつかの処理を実行させます。これは複数行のコマンドを実行する必要がある場合に非常に便利です。 “run_arbitrary_script” ステップではスクリプトを実行します。これはMakefileターゲットを呼ぶ以外の方法で複数のコマンドを実行できる代替案です。

# Job definition block
jobs:
  main:
    requires: [~pr, ~commit]
    # Steps definition block.
    steps:
      - export: export GREETING="Hello, world!"
      - hello: echo $GREETING
      - set-metadata: meta set example.coverage 99.95
  second_job:
    requires: [main] # second_job will run after main job is done
    steps:
      - make_target: make greetings
      - get-metadata: meta get example
      - run_arbitrary_script: ./my_script.sh

作業用リポジトリができたのでScrewdriverのUIよりアプリケーションをビルド・デプロイしてみましょう。（ScrewdriverのYAMLについて詳しくは設定ページをご覧ください。）

Screwdriverによるビルド

Screwdriverを利用するには、Githubを利用してScrewdriverにログインし、パイプラインをセットアップし、ビルドを開始する必要があります。

新しいパイプラインを作成

1. Createアイコンをクリックします。（未ログインの場合はログインページにリダイレクトします）

2. “Login with SCM Provider” ボタンを押します。

3. あなたのリポジトリへのアクセス権をScrewdriverに与えてよいか確認されます。適切に選択し、Authorizeボタンをクリックします。

4. ビルド対象リポジトリのリンクを入力します。SSHかHTTPSリンクの後に#<YOUR_BRANCH_NAME>を付加します(例：git@github.com:screwdriver-cd/guide.git#test)。BRANCH_NAMEが指定されていない場合、デフォルトとしてSCMで設定されているデフォルトブランチが指定されます。 “Use this repository” をクリックし、 ”Create Pipeline” をクリックします。

はじめてのビルドを開始

パイプラインが作成されたら、新しいパイプラインのページに移動します。スタートボタンをクリックしてビルドを開始しましょう。

おめでとう！Screwdriverを利用して最初のアプリケーションをビルド・実行できました🎉