yamory の使い方

yamory へようこそ! yamory の基礎知識と使い方をご紹介します。

コマンドラインから Gradle プロジェクトをスキャンする

このページではコマンドラインから Gradle プロジェクトやAndroid(Gradle)プロジェクトをスキャンする方法について説明いたします。

Gradle プロジェクトをスキャンする

Gradle プロジェクトのコマンドスキャンでは gradle コマンドの dependencies タスクによって依存関係を抽出した出力テキストをスキャンします。
スキャンを行うには、コマンドライン上でスキャン対象の Gradle プロジェクトのルートディレクトリに移動し、以下を実行してください。

gradle :<Gradle のサブプロジェクト名>:dependencies --console=plain | PROJECT_GROUP_KEY=<yamory 上のプロジェクトグループ識別キー> YAMORY_API_KEY=xxxxxxxxxxxxxxxxx bash -c "$(curl -sSf -L https://yamory/script/...)"

上記の < > 内の箇所は、以下の内容に適宜置き換えてください。

<Gradle のサブプロジェクト名>: Gradle のサブプロジェクト名を入力します(ルートプロジェクトのみの場合は、:<Gradle のサブプロジェクト名>: を削除してください)。

<yamory 上のプロジェクトグループ識別キー>:サービス名称などを設定してください(例: yamory)(半角英数記号のみ、半角スペースは入力不可)。

スキャン対象のコンフィグレーションと、スキャンオプション

スキャン対象のコンフィグレーションは、defaultです。任意のコンフィグレーションを指定してスキャンする場合は、上記のコマンドの末尾に下記のスキャンオプションを追記してください。

-- --configuration <コンフィグレーション名>: 任意のコンフィグレーション名を指定してスキャンします。

Android(Gradle)プロジェクトをスキャンする

Android プロジェクトのスキャンは、現在α版での試験的な提供を行っております。ぜひご利用いただき、忌憚ないご意見・フィードバックを募集しています。

Android プロジェクトのコマンドスキャンでは gradle コマンドの dependencies タスクによって Android 用の依存関係を抽出した出力テキストをスキャンします。
スキャンを行うには、コマンドライン上でスキャン対象の Android プロジェクトのルートディレクトリに移動し、以下を実行してください。

gradle :<Gradle のサブプロジェクト名>:dependencies --console=plain | PROJECT_GROUP_KEY=<yamory 上のプロジェクトグループ識別キー> YAMORY_API_KEY=xxxxxxxxxxxxxxxxx bash -c "$(curl -sSf -L https://yamory/script/...)" -- --android-app

上記の < > 内の箇所は、以下の内容に適宜置き換えてください。

<Gradle のサブプロジェクト名>: 通常 app 等の Android の Module 名を入力します(ルートプロジェクトのみをスキャンする場合は、:<Gradle のサブプロジェクト名>: を削除してください)。

<yamory 上のプロジェクトグループ識別キー>:サービス名称などを設定してください(例: yamory)(半角英数記号のみ、半角スペースは入力不可)。

スキャンオプション

スキャン対象とするプロジェクトに応じて、下記いずれかのオプションを指定できます。
オプションを指定する際は、前述のコマンド文字列の末尾 -- --android-app--android-app の箇所のみを以下のいずれかに置き換えてください。

--android-app: Android アプリケーションプロジェクト(releaseRuntimeClasspathコンフィグレーション)をスキャンします。

--android-lib: Android ライブラリプロジェクト(releaseCompileClasspathコンフィグレーション)をスキャンします。

--configuration <コンフィグレーション名>: 任意のコンフィグレーション名を指定してスキャンします。プロダクトフレーバーやフレーバーディメンションをカスタマイズしており、前述のオプションではスキャンできない場合等にご利用ください。