WebCIを使い始める
Bitriseはモバイルに特化したDevOpsプラットフォームです。ただし、それはBitrise上でモバイル以外のプロジェクトをビルドできないという意味ではありません。統合機能、デフォルトのWorkflowsやPipelines、専用のキャッシュソリューションによって、モバイル以外のプロジェクトタイプにも対応しています 。
WebCIにBitriseを使用すると、モバイルを含むすべてのプロジェクトをBitrise上に統合できます。Bitriseは複雑な領域であるモバイルCI/CDに優れているため、モバイル向けの汎用的なCIよりもWeb向けのBitriseを採用する方が容易であり、統合によって運用がシンプルになります。
WebCIプロジェクトの追加Click to copy link
プロジェクトの追加方法は他の場合と同じです。ウィザードの詳しい手順については、新規プロジェクトの追加をご覧ください。このセクションでは、モバイル以外のプロジェクトに特有の内容を説明します。
スキャナーがプロジェクトタイプを検出する仕組みClick to copy link
プロジェクトスキャナーは、サポートされている各言語を識別するファイルがないか、リポジトリを確認します。
- Node.js:
package.jsonファイル。 - Ruby:
Gemfile。 - Python:
requirements.txt、pyproject.toml、Pipfile、またはsetup.pyファイル。 - JavaまたはKotlin: Gradleの場 合は
gradlewファイル、Mavenの場合はpom.xmlファイル。
Node.js、Ruby、Pythonの場合は、Workflowに適した言語バージョンを選択するために、.nvmrc、.ruby-version、.python-versionなどのバージョンファイル(またはプロジェクトのマニフェスト内のengines/requires-pythonフィールド)も読み取ります。これら2つのスキャナーの詳細については、Rubyプロジェクトのデータベース設定およびPythonのパッケージマネージャー検出をご覧ください。
設定できる項目Click to copy link
CI configurationの段階では、ウィザードに検出された各プロジェクトのProject directoryオプションと、該当する場合はパッケージマネージャーの選択肢が表示されます。スキャナーがロックファイルからパッケージマネージャーを検出できない場合は、手動で選択してください。Bitriseが、それに合った設定を生成します。
Rubyプロジェクトのデータベース設定Click to copy link
Rubyプロジェクトを追加すると、プロジェクトスキャナーがデータベースgemを検出します: pg、mysql2、redis、mongoid/mongo、sqlite3。検出された各データベースgemに対して、スキャナーはPostgres、MySQL、Redis、MongoDBのいずれかの適切なサービスコンテナを生成します。各コンテナには正しいイメージ、ポートマッピング、ヘルスチェックが設定されており、テストが接続を試みる前にコンテナが完全に準備できた状態になります。
スキャナーは、リレーショナルデータベース用のconfig/database.ymlとMongoDB用のconfig/mongoid.ymlも解析し、接続の詳細を抽出します。ERB式も解決します。database.ymlにENV.fetch("DB_HOST", "localhost")のような記述が含まれている場合、スキャナーは環境変数名とそのdefault valueの両方を取得します。これらはその後、Bitriseの設定内でアプリレベルのenvironment variablesとして設定されるため、テストWorkflowは手動での環境設定なしにサービスコンテナへ接続します。
スキャナーはdatabase.yml内のtest環境セクションを優先し、testブロックが存在しない場合はdefaultにフォールバックします。これはRails自体が使用するのと同じルックアップ順序です。
依存関係の管理Click to copy link
Bitriseは、依存関係を簡単に扱えるようにする専用のStepsを通じて、複数の依存関係マネージャーをサポートしています。WebCIプロジェクトにおいて特に重要なのは次のとおりです。
-
Run npm command: Node.js用のDefault Workflowsには、
npm installを実行するnpmStepが含まれています。このコマンドは、package.jsonファイルに定義されているすべての必要なパッケージをインストールします。要件に合わせてインストール手順を設定するフラグを指定できます。The npm command with arguments to run入力でコマンドを設定します。入力のデフォルト値はinstallです。設定YAMLファイルでは、
command入力を探してください。- npm:inputs:- command: install -g -
Run yarn command: Yarnもnpmと同様に、
package.jsonファイル内で依存関係を探します。Stepを使用すると、実行したいyarnコマンドや追加の引数を指定できます。The yarn command to run入力にコマンドを追加します。設定YAMLファイルでは、この入力は
commandと呼ばれます。依存関係をインストールするだけの場合は空のままにしてください。- yarn:inputs:- command:Arguments for running yarn commands入力でyarnコマンドの引数を指定します。設定YAMLファイルでは、この入力は
argsと呼ばれます。複数の引数はスペース文字で区切って追加できます。- yarn:inputs:- args: "-dev" -
Gradle Runner: プロジェクトがGradleでビルドされている場合、このStepを使ってプロセス中に依存関係をインストールできます。そのためには、以下が必要です。
- Gradle Wrapper。
- 正しく設定されたGradleタスク。
- ビルドスクリプトで宣言された依存関係。
Stepには2つの入力が必要です。Gradle task to run入力は、ビルド中に実行されるGradleタスクを定義します。Gradle Wrapper path入力は、プロジェクト内の
gradlewファイルへのパスを定義します。設定YAMLファイルでは、これらの入力はそれぞれgradle_taskとgradlew_pathと呼ばれます。- gradle-runner:inputs:- gradlew_path: ./cool_project/- gradle_task: install
Pythonのパッケージマネージャー検出Click to copy link
Pythonプロジェクトの場合、Bitriseは次の順序でパッケージマネージャーのソースを確認したうえで、依存関係管理の設定を作成します。
uvパッケージマネージャーの場合はuv.lock。poetryの場合はpoetry.lock。pipの場合はrequirements.txt。
これらのいずれも見つからない場合、パッケージマネージャーは未検出のままになります。ユーザーはセットアップ時に1つを選択し、その選択に応じた設定が生成されます。
テストの実行Click to copy link
すべてのBitriseプロジェクトには、run_testsというデフォルトのテストWorkflowがあります。Workflowの内容は、正確なプロジェクトタイプによって異なります。
JavaおよびKotlin向けのGradleを使ったテストClick to copy link
GradleでビルドされたJavaおよびKotlinプロジェクトでは、テストはtest Gradleタスクを中心に行われます。Bitriseには、これ専用のStepであるRun Gradle Testsがあり、これはデフォルトのWorkflowの一部です。
- Stepには、プロジェクト内にGradle Wrapperが必要です。このwrapperには、正しく設定されたテストタスクが少なくとも1つ含まれている必要があります。
- 実行したいGradleタスクを設定するには、Test task入力を使用します。デフォルトではStepが
testタスクを実行しますが、任意のGradleタスクを設定できます。 - gradlewコマンドをさらにカスタマイズするには、Additional flags入力を使用します。たとえば、特定のテストクラスを実行するフラグを設定できます。
Java向けのMavenを使ったテストClick to copy link
MavenでビルドされたJavaプロジェクトでは、Maven Wrapper'sのテストコマンドである./mvnw testを実行するScript Stepを使用してテストが実行されます。
Script Stepsは完全に カスタマイズ可能で、必要なMaven設定を自由に作成できます。デフォルトの設定は、目的に合わせていつでも自由に変更できます。Mavenを使ったテストの実行の詳細については、Surefireをご覧ください。
Node.jsプロジェクトのlintとテストClick to copy link
Node.jsプロジェクトの場合、デフォルトのrun_tests Workflowは、テストスイートではなく、Node.jsのインストールとlintの実行という2つの処理をデフォルトで行います。
-
ScriptStep経由でNode.jsをインストールします。これはScript Stepであるため、設定を自由に変更・カスタマイズしてニーズに合わせることができます。デフォルトのソリューションでは、
asdfを使用して単純にNode.jsをインストールします。ヒントset -euxo pipefailexport ASDF_NODEJS_LEGACY_FILE_DYNAMIC_STRATEGY=latest_installedenvman add --key ASDF_NODEJS_LEGACY_FILE_DYNAMIC_STRATEGY --value latest_installedpushd "${NODEJS_PROJECT_DIR:-.}" > /dev/nullasdf install nodejspopd > /dev/null -
npm Stepを使って
npm run lintを実行します。lintコマンドは、コードに潜在的なエラーがないか解析します。
npm Stepでは、テストの実行も可能です。package.jsonファイルに定義されたテストを実行するには、testコマンドを実行します。
RubyプロジェクトのテストClick to copy link
Rubyプロジェクトの場合、適切なテストコマンドを備えたテストWorkflowが自動的に生成されます。Rubyプロジェクトを追加すると、スキャナーはテストフレームワークを探し、見つかった内容に基づいて適切なテストコマンドを選択します。
- RSpec:
bundle exec rspec(各テストコマンドではオプションで、Bundlerが検出された場合にのみ使用されます)。 - Railsプロジェクト内のMinitest:
bundle exec rails test - Rakefileを使用するMinitest(Rails以外):
bundle exec rake test - RailsもRakefileもないMinitest:
bundle exec ruby -Itest test/**/*_test.rb - テストフレームワークはないがRakefileが存在する場合:
bundle exec rake test。
キャッシュClick to copy link
Bitriseは、2つの異なるキャッシュソリューションを提供しています。
- Bitrise Build Cache: BazelまたはGradleでプロジェクトをビルドしている場合、Bitrise Build Cacheが、以降のビルドでの作業量を最小限に抑えるためにビルドとテストの出力をキャッシュします。任意のCIツールと互換性があり、キャッシュインフラストラクチャを管理することなくビルドサイクルを高速化します。
- キーベースのキャッシュ: キーベースのキャッシュは、キャッシュアーカイブをキーに関連付けることで機能します。Workflowは、そのキーを参照してキャッシュアーカイブを復元できます。Workflowの終了時には、そのキーが示すキャッシュアーカイブにビルドファイルを保存できます。これにより、キャッシュアーカイブが上書きされます。
Bitrise Build CacheClick to copy link
Bitrise Build Cacheにnew connectionを追加するには、以下が必要です。
- CIプロバイダーの選択: Bitriseまたは別のCIプロバイダーのいずれかを使用できます。
- ビルドツールの選択: 現在、Bazel、Gradle、Xcodeがサポートされています。
- CIプロバイダーとしてBitriseを使用する場合は、Bitrise projectを選択します。
- 別のCIプロバイダーを使用する場合は、パーソナルアクセストークンを追加して、Bitrise Build CacheがCIにアクセスできるようにします。
- キャッシュ有効化スクリプトをCIプロセスに追加します。Bitriseでは、これ専用のStepsを用意しています。
キーベースのキャッシュClick to copy link
キーベースのキャッシュを使用するには、主に2つの方法があります。
- 専用のキャッシュStepsを使用する方法です。依存関係に必要なcache keysを自動的に設定するため、構成は不要です。専用のStepsには、npm、Yarn、Gradleの依存関係をキャッシュするためのStepsが含まれます。依存関係マネージャー向けの専用キャッシュStepsをご覧ください。
- ScriptStepsを使用して、キャッシュアーカイブのキーを設定する方法です。これにより、キャッシュ設定を完全に制御できます。キーベースのキャッシュの使用をご覧ください。
DockerコンテナのサポートClick to copy link
Bitrise WorkflowsおよびPipelinesでDockerコンテナを使用できます。コンテナのサポートにより、バックグラウンドサービスも利用できるようになります。コンテナ内でビルドを実行すると、ビルド環境を完全に制御でき、ビルド中に依存関係をインストール する必要もなくなります。
DockerイメージのビルドClick to copy link
コンテナを使用するには、Dockerイメージが必要です。Docker Build & Push Stepを使用すると、独自のDockerイメージをビルドしてプッシュできます。Stepには、ビルドしたイメージに適用するイメージタグのリストが必要です。次のことも指定できます。
- ビルドコンテキスト。
- Dockerfileのパス。
Docker Build & Push Stepには、キーベースのキャッシュが組み込みでサポートされています。つまり、Stepは、プリセットのcache keysを使用して、ビルドしたDockerイメージを自動的にキャッシュします。詳細については、独自のDockerイメージのビルドをご覧ください。
コンテナの使用Click to copy link
ビルドでコンテナを使用するには、次のことが必要です。
- コンテナを定義します。コンテナIDと、Dockerイメージの名前およびバージョンが必要です。
- WorkflowまたはPipeline内で、コンテナをそのIDによって参照します。同じWorkflow内の異なる部分を、異なるコンテナで実行できます。
また、Dockerコンテナをサービスとして実行できるサービスコンテナを定義し、高度な統合テストを行うこともできます。
詳細については、BitriseにおけるDockerコンテナについてをご覧ください。
デプロイClick to copy link
WebCIプロジェクトは、次の3つの方法のいずれかでデプロイできます。
-
Deploy to Bitrise.io Step: ファイルをBitriseにデプロイします。StepのDeploy directory or file path入力に、デプロイしたいファイルのパスを設定します。ビルドが成功すると、ビルドページのArtifactsタブでファイルを確認できます。ここからファイルをダウンロードできます。
詳細については、オンラインのビルドアーティファクトをご覧ください。
-
カスタマイズされたScript Step: 独自のカスタムスクリプトを使用してプロジェクトをデプロイします。Stepは、一般 的なスクリプト言語をすべてサポートしています。Stepでは、独自のEnvironment Variablesを作成してエクスポートし、以降のStepsからアクセスすることもできます。Script Stepsを使えば、すべてを完全に制御できます。
-
専用のデプロイStep: これらのStepsは、Webプロジェクトを特定のサービスにデプロイします。たとえば、Amazon S3 Bucket Sync Stepは、ローカルフォルダの内容をAmazon S3バケットにアップロードします。Heroku Deploy Stepは、Heroku ToolbeltでアプリをHerokuにデプロイします。
今後もできるだけ多くのユースケースに対応できるよう、新しいデプロイStepsを積極的に追加していきます。