Skip to main content
これはブループリントの完全なフィールドリファレンスです。ブループリントの概要と、Devin の環境内でどのように機能するかについては、宣言的 環境設定を参照してください。
ブループリントは、Devin の環境をどのように構成するかを定義します。具体的には、どのツールをインストールするか、依存関係をどのように最新の状態に保つか、そして Devin が認識しておくべきコマンドを定めます。

概要

ブループリントは、次の 3 つの主要なトップレベルセクションに加え、org レベルおよび Enterprise レベルのブループリント向けの post-build セクションと、リポジトリレベルのブループリントで任意に追加できる clone セクションで構成されています。
すべてのセクションは任意です。任意の組み合わせで含めることができます。 initialize はフルビルド時およびゼロから再構築されるワークスペースに対して実行されます。結果はスナップショットに保存されます。差分ビルド では、継承されたワークスペースは initialize を skip し、最新のコードを pull して、maintenance のみを実行します。maintenance は、それ単体で完結し、既存のスナップショット上で独立して実行できるように記述してください。直前に initialize の実行が必要にならないようにし、initialize が以前に $ENVRC に書き込んだ environment variables に依存しないようにしてください。各セッションの開始時には、maintenance コマンドは 自動実行されません。代わりに、必要に応じて (たとえば最新のコードを pull した後に) どの依存関係コマンドを実行すべきかをエージェントが把握できるよう、前提情報として提示されます。コマンドは高速で、差分的に実行できるものにしてください。ビルドは ブループリント が変更されたときと、定期的 (約 24 時間ごと) に自動実行されます。

initialize

initialize は、コードの特定の状態に依存しないツールやランタイム (言語ランタイム、システムパッケージ、グローバル CLI など) をインストールする際に利用します。

シンプルな形式

単純なシェルコマンドには、ブロックスカラーを利用します:

構造化された形式

名前付きステップ、環境変数、または GitHub Actions には、リスト形式を利用します:
両方の形式は混在させて使用できます。シンプルな形式は、run を含む 1 つのステップと同等です。

initialize と maintenance の使い分け

どちらのセクションもフルビルド中に実行されます。差分ビルドでは、継承されたワークスペースは最新のコードを取得した後、initialize をスキップし、maintenance のみを実行します。ツールやランタイムは initialize に、コードのロックファイルに追従する依存関係コマンドは maintenance に入れます。

maintenance

maintenance は、コードのクローン後に実行する依存関係のインストールやその他のコマンドに利用します。これらのコマンドはビルド中に実行され、セッション開始時にエージェントにも共有されるため、依存関係が変更された場合はエージェントが再実行できます。npm installpip installuv sync などのコマンドはここに含めます。
あるいは、構造化された形式では次のとおりです:
リポジトリレベルのブループリントでは、maintenance コマンドはリポジトリのルートディレクトリで実行されます。org レベルのブループリントでは、ホームディレクトリ (~) で実行されます。

knowledge

knowledge セクションは実行されません。これは、Devin がプロジェクトで作業する際に参照する情報です。ここでは、lint、テスト、ビルド、その他のプロジェクト固有のワークフローで使用する正しいコマンドを Devin に伝えます。
各 Knowledge アイテムには、以下のフィールドがあります。 name フィールドはラベルです。慣例として、linttestbuild が標準的な名前です。Devin は自身の作業を検証する際に、これらを参照します。任意のカスタム名で、追加の Knowledge アイテムを作成できます。

post-build

post-build セクションは、org レベルおよび Enterprise レベルのブループリントでのみ利用できます (リポジトリレベルのブループリントではサポートされていません) 。このセクションのステップは、ビルド中にすべてのリポジトリのクローンと、それらの initialize ステップおよび maintenance ステップの完了後、ヘルスチェックとスナップショットイメージの作成より前に実行されます。そのため、環境全体が組み上がった状態を必要とする、リポジトリ横断の検証やヘルスチェックに適しています。 環境全体がそろった状態でビルドの後半に実行されるため、post-build ステップでは、クローンされたすべてのリポジトリと、Enterprise、組織、repo の各ブループリントによってインストールされたすべてのツールを参照できます。
また、構造化すると次のようになります:
post-build ステップは、終了コードが 0 以外だとビルドを失敗にしますpost-build ステップが 0 以外で終了すると、ビルドは失敗として扱われ、スナップショットイメージは生成されません。これを利用すれば、ヘルスチェックを通過した場合にのみスナップショットを作成できます。ただし、不安定なチェックでビルドが止まらないよう、コマンドは確実に動作するものにしてください。
post-build ステップでは、initializemaintenance と同じ step types (シェルの run コマンドと GitHub Actions の uses) を使用し、ホームディレクトリ (~) から実行されます。

clone

リポジトリレベルのブループリントでは、省略可能なcloneセクションで、Devin がリポジトリをスナップショットにクローンする際に使われるデフォルト設定を上書きできます。すべてのフィールドは省略可能で、指定しない場合は現在の動作を維持する適切なデフォルト設定が適用されます。
cloneリポジトリレベル ブループリントでのみ有効です。これは、その特定の repo を snapshot にどのようにクローンするかを制御します。org レベル または enterprise-level のブループリントでは効果はありません。

step types

initializemaintenance、または post-build の各ステップでは、シェルコマンド (run) または GitHub Actions (uses) の 2 種類のいずれかを利用します。

シェルコマンド (run)

bash で任意のシェルコマンドを実行します。
実行の詳細:
  • コマンドは bash で実行されます。複数行スクリプト内のいずれかのコマンドが失敗すると、そのステップ全体が直ちに停止します。
  • org レベルのブループリントはホームディレクトリ (~) で実行されます。
  • リポジトリレベルのブループリントは、クローンされたリポジトリのルートディレクトリで実行されます。
  • 各ステップのタイムアウトは 1 時間です。
  • シークレットは自動的に環境変数として利用できます。

GitHub Actions (uses)

Node.js ベースの GitHub Actions をブループリント内で直接実行できます:
Action 参照形式:
github.com/ プレフィックスと @<ref> サフィックスは、どちらも必須です。ref は通常、v5 のようなバージョンタグです。 よく利用されるアクション:
サポートされているのは Node.js ベース の GitHub Actions のみです。Composite アクションと Docker ベースのアクションはサポートされていません。
with の値の仕組み: with で渡した値は、GitHub Actions のワークフローと同じ規則に従って、アクションへの入力として与えられます。すべての値は文字列に変換されます。
アクションによる変更の伝播方法: アクションは、後続のステップで使用される環境を変更できます。たとえば、setup-python は Python の実行ファイルを PATH に追加するため、それ以降のすべてのステップと maintenance で引き続き利用できます。

run と uses: どちらを使うべきか

実際には、ほとんどの設定で、言語ランタイムには uses を使い、それ以外には run を使います。

環境変数とシークレット

ステップごとの環境変数

どのステップでも、env フィールドを使って追加の環境変数を定義できます。
これらはそのステップ内でのみ有効で、後続のステップには引き継がれません。

ステップ間の環境変数 ($ENVRC)

ステップ間で環境変数を引き継ぐには、$ENVRC ファイルに書き込みます。
$ENVRC に書き込まれた変数は自動的にエクスポートされ、後続のすべての ステップおよび現在のビルドで生成された Devin セッションで利用できます。これは、 GitHub Actions の $GITHUB_ENV と同様の仕組みです。 これは PATH にも当てはまります。標準的でないディレクトリにツールをインストールした場合 (/usr/bin または /usr/local/bin 以外の場所) 、後続のステップやリポジトリレベルのブループリントが そのバイナリを見つけられるよう、$ENVRC に追記してください。
run: ブロック内で単に export PATH=... を実行しても、影響するのはそのステップのシェルだけです。 各ステップは新しいシェルプロセスを開始するため、$ENVRC に書き込まれない PATH の変更は失われます。
uses: actions (例: actions/setup-node) は、追加した PATH を自動的に $ENVRC に反映します — これを手動で行う必要があるのは run: ステップだけです。
$ENVRC は、差分ビルド を含むすべてのビルドの開始時にリセットされます。 あるビルド中に書き込まれた値は、次のビルドでは利用できません。特に、 継承された ワークスペース は maintenance のみを実行するため、親 ビルドで initialize$ENVRC に書き込んだ PATH やその他の変数は利用 できません。maintenance に必要な環境は、 maintenance 自体の中で設定してください。

シークレット

Devin UI (各ブループリントエディタの Secrets タブから) で設定したシークレットは、自動的に環境変数として注入されます。ブループリント で宣言する必要はありません。名前で参照するだけです (例: $MY_SECRET) 。 シークレットは、ビルド中に各ステップが実行される前に毎回注入され、さらに 各セッションの開始時にも再度注入されます。シークレット自体はスナップショットイメージから除去されるため、認証情報が保存済みのマシンイメージに埋め込まれることはありません。
  • 組織のシークレット: 組織内のすべての ブループリント にあるすべてのステップで、環境変数として利用できます。これらは組織全体のブループリントエディタの Secrets タブで設定します。
  • Enterprise のシークレット: 組織のシークレットとマージされます (同名のシークレットが競合した場合は、組織のシークレットが優先されます) 。Enterprise 内のすべての組織で利用できます。
  • リポジトリのシークレット: リポジトリごとのファイル /run/repo_secrets/{owner/repo}/.env.secrets に書き込まれます。ビルド中は、そのリポジトリの ブループリント のステップが実行される前に、リポジトリのシークレットが自動的に source されます。セッション時には、Devin がそのリポジトリで作業するときにそれらを source します。これらは、リポジトリのブループリントエディタの Secrets タブで設定します。
ビルド専用のシークレット: 「build only」としてマークされたシークレットは、スナップショットのビルド中は利用できますが、スナップショットが保存される前に削除されます。これは、ビルド時にのみ必要な認証情報 (例: initialize 中に非公開アーティファクトをダウンロードする場合) に利用してください。
maintenance はビルド中に実行されます。セッション開始時には、maintenance コマンドがエージェントに提示され (自動実行はされません) 、必要に応じてエージェントが再実行することがあります。maintenance ステップが設定ファイル (例: ~/.m2/settings.xml, ~/.npmrc) にシークレットを書き込むと、それらのファイルはスナップショットに組み込まれます。認証情報を書き込むステップは、定期的なビルド中に更新されるよう initialize ではなく maintenance に配置してください。ただし、書き込まれたファイルはイメージ内に保持される点に注意してください。最大限の安全性を確保するには、認証情報をディスクに書き込む代わりに、環境変数または $ENVRC を利用してください。

ファイルの添付

ブループリント エディタから、ファイル (.npmrcsettings.xml、設定ファイルなど) をアップロードできます。アップロードされたファイルは ~/.files/ に書き込まれ、各ファイルのパスを指す環境変数が設定されます。
変数名はファイル名に由来し、英数字以外の文字はアンダースコアに置き換えられ、先頭に FILE_ が付きます。 ブループリントのステップでファイルを添付する:

Git連携のブループリント

ブループリントは、リポジトリ内に .devin/blueprint.yaml ファイルとして直接保存し、API または UI から同期できます。セットアップ手順と詳細については、Git連携のブループリント を参照してください。

完全な例

ブループリントが階層 (enterprise → org → repo) をまたいでどのように組み合わされるか、ビルド ステータス、リポジトリの状態、再ビルドのトリガーになる条件については、宣言的構成ページのビルドと セッションを参照してください。

組織全体のブループリント

組織内のすべてのリポジトリで必要となる共有ツールです。これは最初に (Enterprise ブループリントがある場合はその後に) 、ホームディレクトリで実行されます。

リポジトリレベルのブループリント

Node.js + Python のモノレポ向けの、プロジェクト固有のセットアップです。これは組織全体向けのブループリントの後に、リポジトリディレクトリ内で実行されます。