パイプとは

パイプについて

パイプを使用して、パイプラインを簡単に構成することができます。特に、サードパーティのツールで作業する場合に便利です。yaml ファイルにパイプを貼り付け、いくつかの主要な情報を指定するだけで、残りは自動的に行われます。ステップには任意の数のパイプを追加できます。

1 2 3 4 5 6 7 8 script: - pipe: atlassian/aws-s3-deploy:0.2.2 variables: AWS_ACCESS_KEY_ID: $AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY: $AWS_SECRET_ACCESS_KEY AWS_DEFAULT_REGION: 'us-east-1' S3_BUCKET: 'my-bucket-name' LOCAL_PATH: 'build'

利用可能なパイプの一覧

動作の仕組み

パイプは Docker コンテナにあるスクリプトを使用し、過去に yaml に配置したコマンドといくつかの追加コマンドを含みます。

ユーザーはいくつかの値を入力するだけです。アトラシアンが提供しているタスクは公開されているため、ユーザーはソース コードを参照して動作の仕組みを確認することができます。


例: Amazon S3 バケットにアップロードするためのパイプを追加する

パイプラインで build ディレクトリのコンテンツを my-bucket-name S3 バケットにアップロードする場合、AWS S3 デプロイ パイプを使用できます。

AWS S3 デプロイ デモ GIF
  1. [AWS S3 デプロイ パイプ] を選択します。

  2. コピー をクリックします。

  3. カーソルをデプロイメント ステップのスクリプト セクションに移動させます (場所が重要です)。 

  4. コピーしたコードを貼り付けます。

  5. 通知: ここではオプション パラメーターは削除していますが、必要に応じてコメント化を解除することができます。

  6. デプロイメントのパラメータ値を追加します (常に一重引用符で囲みます)。

    1. using our predefined variables $AWS_ACCESS_KEY_ID and $AWS_SECRET_ACCESS_KEY

    2. specifying our region as us-east-1

    3. supplying the name of our bucket: my-bucket-name

    4. defining that we want to deploy the contents of our build folder

1 2 3 4 5 6 7 8 script: - pipe: atlassian/aws-s3-deploy:0.2.2 variables: AWS_ACCESS_KEY_ID: $AWS_ACCESS_KEY_ID AWS_SECRET_ACCESS_KEY: $AWS_SECRET_ACCESS_KEY AWS_DEFAULT_REGION: 'us-east-1' S3_BUCKET: 'my-bucket-name' LOCAL_PATH: 'build'

AWS Elastic Beanstalk デプロイや NPM Publish などの一部のデプロイメント パイプでは、デプロイしたアプリケーションを表示できる便利なリンクをログに提供しています。

デプロイのサンプル gif

パイプの使用方法

パイプラインにパイプを追加するには、2 つの方法があります。

1. オンライン エディターの使用

  1. エディタで bitbucket-pipelines.yml ファイルを開きます。

  2. 必要なパイプを選択します。

  3. パイプをコピーして、ステップの script セクションに貼り付けます。

  4. 指定する値を、単一引用符で囲んで追加します (必要に応じ、使用したいオプション パラメータのコメントを解除します)。

  5. ビルドを実行します。

変数値をインラインで入力したり、事前に定義された変数を使用したりすることができます。

2. 構成を直接編集する

任意のエディタを使用して、bitbucket-pipelines.yml ファイルにタスクの詳細を追加できます。

The README.md file in the available pipes listed below contains instructions on how to use the pipe and the lines you can copy and paste into your bitbucket-pipelines.yml file. While you are in the pipe repo you can have a peek at the scripts to see all the good stuff the pipe is doing behind the scenes.

考慮事項:

  • パイプでは Docker サービスを使用する必要があります。これは透過的に開始されます。これは、ステップ内で実行できるサービス数に計上されます。デフォルトでは、この docker サービスは 1 GB のメモリを使用できますが、パイプにさらにメモリが必要な場合、構成で変更できます

  • パイプはセマンティック バージョニングを使用するため、パイプに変更を加えるとバージョン番号が変更されます。リポジトリの変更履歴の更新を予定しています。別のバージョンを使用する場合、bitbucket-pipelines.yml  ファイルでバージョン番号を変更できます。0.x.y のバージョンのパイプはまだ開発中であるため、従来のセマンティック バージョニングの例外であり、マイナー バージョンとパッチ バージョンの変更との間に大規模な変更をもたらす可能性があることに注意してください。

    例:

    変更前: pipe: atlassian/aws-s3-deploy:0.1.0

    変更後: pipe: atlassian/aws-s3-deploy:0.2.0

パイプが不足している場合

確認したいパイプが見つからない場合、独自のパイプを作成するか、Bitbucket エディタの [パイプを提案] ボックスを使用します。

[パイプを提案する] フィールドと [送信] ボタンが表示された画像

パイプで支援が必要な場合

もっとも簡単に支援を得る方法は、リポジトリの readme にあるパイプのサポート手順に従うことです (これはパイプを選択するとエディタにも表示されます)。

一般的なサポートをご希望の場合、または課題や機能についてのリクエストがある場合は、コミュニティでお知らせください

問題を報告する場合は、迅速な調査のため、以下の情報を含めてください。

  • パイプのバージョン

  • 関連するログとエラー メッセージ

  • 再現手順

その他のヘルプ