よくある質問と回答

ステップをスキップする方法は？

1つのステップを除いた形であるテンプレートを利用したいということが有るかもしれません。

それを行うには、不要なステップを成功ステータスを返す任意のシェルコマンドに取り替えてください。echoや、true、:のようなものが該当します。コマンドは文字列でなくてはならないので、trueや:はクオートで囲んでください。バッククォートで囲われたコマンドもクォートで囲んでください。成功以外のステータスを返すコマンドはビルドを中止させます。

Screwdriver.yamlの例（一部）:

steps:
  - first: echo I am skipping step first
  - second: 'true'
  - third: ":"
  - WRONG: "`exit 22`"

ビルドをスキップする方法は？

README等ちょっとしたドキュメント修正のみの時など、screwdriverのビルドをスキップさせたい場合があると思います。

ベースブランチにpushする際にビルドをスキップさせたい場合は、プルリクエストのcommitメッセージのいずれかに[ci skip] または [skip ci]の文字列を追加してください。

注意: プルリクエストビルドはスキップ出来ません。 commitメッセージに [skip ci] や [ci skip] を含めても、プルリクエスト時のビルドはスキップされません。（プルリクエストビルドは常に実行されます）

パイプラインの作り方は？

新しいパイプラインを作成するには、画面右上の作成アイコンをクリックし、gitリポジトリのURLをフォームに入力してください。ベースブランチ以外のブランチを指定する場合は、#の後にブランチ名を指定してください。

Create a pipeline

パイプラインを手動で開始するには？

ビルドを手動で開始させたい場合は、パイプラインページにある「Start」ボタンをクリックします。 または、ビルドを選択後ドロップダウンメニューで「Start pipeline from here」を選択します、次に「Yes」をクリックするとビルドが起動します。 パイプラインを開始すると~commitをトリガーにもつ全てのジョブのビルドが開始します。

スタートボタンをクリック： Start a pipeline

2番目のオプションについては、ビルドを再実行、Detached Jobをスタートするには？を参照してください。

パイプラインのリポジトリやブランチを変更したい場合は？

パイプラインのリポジトリやブランチを変更したい場合は、「Options」タブをクリックして、Checkout URLの入力欄を更新し、「Update」ボタンをクリックしてください。

Update a pipeline

リポジトリを転送したりリネームした場合は、パイプラインを同期して、ページをリロードしてください。

ジョブの disable/enable を一時的に切り替えるには？

一時的にジョブの disable/enable を切り替えるには、「Options」タブの画面で、切り替えたいジョブの横にあるトグルボタンをクリックして切り替えを行ってください。 オプションで、ジョブをdisable/enableにする理由を指定することもできます。

Disable a pipeline

パイプラインがソースコードと正しく同期しているか確かめるには？

もしソースコードで何か変更を加えてもパイプラインが同期されない場合は、「Options」タブの「Sync」欄にあるアイコンをクリックして同期してください。 同期は「SCM webhook」、「Pull Request」、「Pipeline」とそれぞれ別々に同期できます。

Sync a pipeline

パイプラインを削除するには？

パイプラインを削除するには、「Options」タブ内にある削除アイコンをクリックします。一度削除したパイプラインは戻すことは出来ませんのでご注意ください。

Delete a pipeline

パイプラインメトリクスを表示するには？

メトリクスページにアクセスするには、 ビルドをクリックして「Go to build metrics」を選択するか、パイプラインページのタブの「Metric」を選択してください。

See metrics

ビルドログの時間形式を切り替えるには？

ビルドログの左上の文字列をクリックすると、Since build started, Since step started, Local TimeStamp, UTC TimeStamp などの時間形式に切り替えることができます。 Toggle time formats

「Build failed to start」のエラーを修正するには？

このエラーは（VMのexecutorを使用している場合は）hyperdのプロセスがダウンしているなどクラスタセットアップ時の問題や、ビルドを行うDocker imageの問題など、様々な理由で起こります。 従ってどのレイヤーでエラーが起きているかによって修正する方法も変わってきます。

  1. /opt/sd/launch: not found このエラーが出る場合はAlpineベースのimageを利用していることが原因となります。glibcの代わりにmuslが使われているためです。回避策としてはDocker imageの作成時に下記のシンボリックリンクを作成します。 mkdir /lib64 && ln -s /lib/ld-musl-x86_64.so.1 /lib64/ld-linux-x86-64.so.2
  2. hyperdのバグが時々発生し、VOLUMEの定義されたイメージが継続的に起動に失敗します。そういったイメージの一つにgradle:jdk8が上げられます。現時点でのワークアラウンドは他のdocker imageを利用するか、 このDockerfileからVOLUMEの行を除いてリビルドすることです。

ビルドのロールバックを行うには？

ビルドのロールバックを行うには下記の２パターンの方法があります。

過去のビルドを再実行、Detached Jobを実行するには？

過去のイベントから再ビルドを行う手順は下記の通りとなります。

  1. イベントリストから目的のイベントをクリックすると、詳細なイベントグラフが表示されます。
  2. ビルドを再実行したいジョブをクリックします。
  3. ポップアップから「Start pipeline from here」のリンクをクリックします。
  4. 最後に「YES」を押してジョブを実行させます。 Load event graph Start new build for job

ロールバックするにはdetached buildで行います。 Metadataを使って最後のジョブ（下記の例ではジョブD）でmeta setコマンドでイメージ名やバージョン情報のメタを設定し、ロールバック用のジョブ（下記の例ではdetached）でmeta get コマンドを使用して設定されたメタ情報を取得します。detachedジョブはジョブDで設定されたメタ情報にアクセスできます。

ビルドをUNSTABLEの状態にするには？

ビルド中にAPIを呼び出すことで、ビルドのステータスをUNSTABLEにすることができます。Screwdriver.cdは、このステータスで表示されたビルドを成功ではないものとみなし後続のジョブを実行しません。 詳しくはUNSTABLEビルドのサンプルリポジトリを参照してください。

Screwdriverが使用しているシェルは？

ステップに記述した処理はデフォルトでBourne shell (/bin/sh)で実行されます。他のシェル（bashなど）で実行したい場合はUSER_SHELL_BIN環境変数で指定することができます。

Artifactsをアップロードする時間を短縮するには？

管理者が予め使用できるように設定していれば、SD_ZIP_ARTIFACTSの環境変数をtrueにすることで、Artifactsをアップロードする前にzip化します。

パイプラインのジョブやArtifactsへのPermalinkは？

パイプラインのジョブやArtifactsを指定されたステータスでパーマリンクするには、以下の形式で指定できます。

/pipelines/{PIPELINE_ID}/jobs/{JOB_NAME}/latest
/pipelines/{PIPELINE_ID}/jobs/{JOB_NAME}/latest?status={STATUS}
/pipelines/{PIPELINE_ID}/jobs/{JOB_NAME}/artifacts?status={STATUS}
/pipelines/{PIPELINE_ID}/jobs/{JOB_NAME}/artifacts/file-path?status={STATUS}

例:

https://cd.screwdriver.cd/pipelines/1/jobs/main/latest
https://cd.screwdriver.cd/pipelines/1/jobs/main/latest?status=SUCCESS
https://cd.screwdriver.cd/pipelines/1/jobs/main/latest?status=FAILURE
https://cd.screwdriver.cd/pipelines/1/jobs/main/artifacts?status=SUCCESS
https://cd.screwdriver.cd/pipelines/1/jobs/main/artifacts/meta.json?status=SUCCESS

shallow cloningを無効にするには？

shallow cloningを無効にするには、GIT_SHALLOW_CLONEの環境変数をfalseにセットします。

デフォルトではScrewdriverはdepth 50でソースリポジトリをshallow cloneします。また、--no-single-branchのフラグもデフォルトで有効にしています。

shallow cloningを有効のままにしてgitリポジトリへpushを行うのであれば、使用するイメージに含まれるgitのバージョンが1.9かそれ以上である必要があります。あるいは、sd-step exec core / git" GIT COMMAND "を呼び出して、Screwdriverにバンドルされているバージョンのgitを使用することもできます。

ビルドイメージの最小ソフトウェア要件は？

Screwdriverはビルドコンテナイメージに制限がありません。しかし、最低でもcurlとopensshがインストールされている必要があります。さらに、コンテナのデフォルトユーザはrootもしくはsudo NOPASSWDが有効になっている必要があります。

また、imageがAlpineベースの場合は、追加で次のシンボリックリンクのような回避策が必要です。 mkdir -p /lib64 && ln -s /lib/ld-musl-x86_64.so.1 /lib64/ld-linux-x86-64.so.2

Saucelabsとの連携は？

ブログ記事を参考にしてください。 https://blog.screwdriver.cd/post/161515128762/sauce-labs-testing-with-screwdriver

サンプルリポジトリはこちらです。 https://github.com/screwdriver-cd-test/saucelabs-example

ビルド内からGitリポジトリにpushされたときにパイプラインを実行するには？

Screwdriverはデフォルトでgitユーザーにsd-buildbotを使用します。したがって、ビルド内でgitコミットを行うと、コミットユーザーはsd-buildbotになります。

これは、webhook処理に影響を及ぼします。 ヘッドレスユーザーがパイプラインを無期限に実行することを防ぐために、ヘッドレスユーザーによるコミットを無視するようにScrewdriverクラスター管理者はwebhookプロセッサの設定を行えます。これを行うには、IGNORE_COMMITS_BY環境変数を設定します。通常、デフォルトgitユーザーのsd-buildbotがこのリストに追加されます。

ユーザーは、別のgitユーザーを使用することでこの動作を上書きできます。例えば、git config --global user.name my-buildbot と git config --global user.email my-buildbot-email を行うことで、Screwdriverのビルドからのgitコミットはmy-buildbotユーザーによって行われ、webhookプロセッサに無視されることなく、Screwdriverパイプラインが実行されます。

sd-setup-scmステップで、プルリクエストのビルドが fatal: refusing to merge unrelated historiesエラーで終了するのはなぜ？

プルリクエストを出しているブランチに、 $GIT_SHALLOW_CLONE_DEPTHコミット (デフォルト:50)以上のコミットがある場合エラーで失敗することがあります。 このメッセージは、gitがfeatureブランチとmainブランチの間に共通の祖先が見つけられないことを示しています。 この問題を解決するには、$GIT_SHALLOW_CLONEを無効にする、大きな数に調整するまたは、featureブランチのコミット数を減らしてください。 (例: rebase, squashなど) 詳しくはこちらのドキュメントをご確認ください。

パイプラインをスタートまたは削除した時にNot foundとなるのはなぜ？

Screwdriverのパイプラインは利用しているSCMのリポジトリと1対1の関係があり、この関係はSCMのリポジトリ名だけでなくリポジトリのユニークIDによって関係付けられています。Not FoundエラーはSCMのリポジトリを削除して同じ名前で再作成した際に発生します（削除後に再度forkした場合も同じです）。この操作により新しいSCMのリポジトリは新しいIDで作成されるのでScrewdriverの検証で失敗します。

もしパイプラインがこの状態になってしまったら、以下のいずれかを行ってください。

  1. パイプラインを作り直しScrewdriverの管理者に古いパイプラインを消すように言ってください。
  2. パイプラインのIDを元のままにしたい場合は、Screwdriverの管理者にDBを直接更新するように言ってください。pipeline.scmUri のフィールドを新しいSCMのリポジトリのIDに置き換える必要があります。

凍結したジョブを開始するには？

一時的にジョブの凍結（freeze windows）設定を上書きして手動でビルドを開始するには、UI、commit、APIを使用することができます。

UIを使用する場合:

  1. 凍結しているビルドのアイコンをクリック
  2. “Start pipeline from here”をクリック
  3. 確認ウィンドウのReasonの部分に、開始する理由を記載
  4. Yesをクリック

Freeze window graph

Freeze window force start

commitを使用する場合: 開始したいビルドのコミットメッセージを [force start] という文字列を含んだものにして、それをマージしてください。

APIを使用する場合: 開始したいビルドの causeMessage を [force start] という文字列を含んだものにして、 POST SCREWDRIVER_API/v4/events のAPIを使って開始してください。

凍結したジョブをキャンセルして予定されたビルドが行われないようにするには？

凍結したジョブは、freeze windowsの期間の終わりに実行されるようにスケジュールされます。場合によっては、ユーザーは screwdriver.yaml の設定を変更せずにスケジュールをキャンセルして、今後予定されているスケジュールビルドが実行されないようにしたいことがあります。その場合は、以下の手順でキャンセルすることができます。

UIでは

  1. フリーズしたビルドアイコンをクリックします。
  2. “Stop frozen build”をクリックします。

これにより、ビルドのステータスが「FROZEN」から「ABORTED」に設定され、今後予定されている実行のための設定が削除されます。

Stop frozen build Aborted frozen build

ビルドが最新のgit shaで実行されたかどうかを知るには？

もしビルドイベントのgit shaが最新のものであれば、Screwdriver UI上ではgit shaを青背景で表示します。

以下のスクリーンショットでは、最初のイベントはgit shaが最新なので背景が青になっていますが、2番目のイベントでは背景色はありません。

古いイベントからビルドを開始した場合、イベント一覧の一番上は最新のイベントのものではなくなります。最新のイベントは下にスクロールすると見つけられます。

Latest SHA

Pipeline does not have admin, unable to start job.のメッセージが表示されるのはなぜ？

パイプラインに有効なadminが存在しない場合、定期実行ジョブのようなスケジューリングされたジョブは失敗します。このジョブにSlackやメールの通知設定がされていた場合Screwdriverはジョブの定期実行が失敗した際にSlackやメールでこのメッセージを送信します。

この問題を解消するには、オプションタブからパイプラインのsyncを実行してください。