このコマンドを使用して、パッケージを公開します。
目的
publish コマンドは、
パッケージをライブラリー・サーバーに公開したり、ライブラリー・サーバーでパッケージを更新したり
するのに使用されます。パッケージを公開するには、パッケージ記述子ファイルを使用できなければ
なりません。パッケージ記述子ファイルは、単一パッケージを記述し、
この単一パッケージは Rational® Asset Manager 内の 1 つのアセットに対応します。
パラメーター
publish コマンドは、引数なしでも、
圧縮ファイルを使用しても、ロケーションを指定しても使用できます。コマンド・ラインで
構成ファイルを指定することもできます。
| 引数 |
説明 |
必須 |
| -o |
-o パラメーターを使用して、ライブラリー・サーバーの
既存パッケージを上書きします。 |
いいえ |
| (引数の指定なし) |
パッケージ記述子は、現行ディレクトリー内に存在する必要があります。
現行ディレクトリー内のすべてのファイルは、ライブラリー・サーバー上のアセットに対する
成果物としてアップロードされます。現行ディレクトリーにパッケージ記述子が含まれていない場合、パッケージ記述子に対してすべてのサブディレクトリーが検索されます。パッケージ記述子が含まれている各サブディレクトリーは、
公開するパッケージとして処理されます。 |
いいえ |
| compressed_file |
パッケージは、.zip 形式で圧縮する必要があります。
パッケージ記述子は、圧縮ファイルのルート・フォルダー内に存在しなければなりません。圧縮ファイルは解凍されて、アーカイブ内のファイルが
ライブラリー・サーバー上のアセットに対する成果物としてアップロードされます。 |
いいえ |
| pathname |
パッケージ記述子は、ロケーションのルートに存在する必要があります。
ロケーション内のすべてのファイルは、ライブラリー・サーバー上のアセットに対する
成果物としてアップロードされます。ロケーションにパッケージ記述子が含まれていない場合、パッケージ記述子に対してすべてのサブディレクトリーが検索されます。
パッケージ記述子が含まれている各サブディレクトリーは、公開するパッケージとして処理されます。このパラメーターを使用して、一度に複数のパッケージを公開できます。パッケージは、その他のパッケージ内に定義できないことに
注意してください。 |
いいえ |
| -c component_name:component_value |
ライブラリー・サーバーで作成するコンポーネント・パッケージの
名前およびバージョン。コンポーネント・パッケージは、
publish コマンドによりアップロードされるすべてのパッケージを表します。 |
いいえ |
| -id build_ID |
公開する場合に SNAPSHOT 変数を
置換する値。 |
いいえ |
| -config configuration_file |
ライブラリー・サーバーとの通信で使用される、
構成ファイルへの完全パス。コマンド・ラインで構成ファイルを指定しない場合、
現行ユーザーのホーム・ディレクトリーの .ram サブディレクトリーにある
デフォルトの構成ファイルが使用されます。 |
いいえ (現行ユーザーのホーム・ディレクトリーの .ram サブディレクトリーに
デフォルトの構成ファイルが存在する場合) |
パッケージ記述子の構文規則
パッケージとは、
ファイルの集合です。アプリケーション成果物、インストール・スクリプト、および
ドキュメンテーションのすべてをパッケージの対象にすることができます。コマンド行インターフェースは、
JSON ファイルの package.json をパッケージ記述子として
識別します。コマンド行インターフェースは、Maven の pom.xml ファイルおよび .pom ファイルも
パッケージ記述子として識別しますが、任意のパッケージで複数のパッケージ記述子を使用できる場合、
package.json ファイルが
優先されます。パッケージ記述子には、パッケージの id パラメーターおよび version パラメーターが
含まれている必要があります。パッケージ内のその他のパラメーター記述子は、オプションです。
Maven POM ファイルをパッケージ記述子として使用して公開する場合、
POM ファイルの groupId パラメーターは、
アセットの Group.Id 属性として作成されます。
- id
- パッケージ ID は固有でなければなりません。
- バージョン
- パッケージ・バージョンは、セマンティック・バージョニングのルールで処理されます。
セマンティック・バージョニングのルールについて詳しくは、『Semantic Versioning』を参照してください。
予約語である SNAPSHOT を使用して、現在のビルドの
タイム・スタンプを指定することもできます。例えば、バージョン 1.0.0-SNAPSHOT は、
最新のビルドが 2010 年 11 月 20 日の午後 5 時に実行されていれば、1.0.0-20101120-1700 に
拡張されます。
- 説明
- テキストによるパッケージの説明はオプションです。
- 所有者
- owners パラメーターは、以下の形式を使用して記述される、担当者情報の配列です。
{ "name" : "Simone Dray",
"email" : "simdray@example.com",
"url" : "http://simdray.example.com"
}
短縮バージョンの情報
(例: "Simone Dray <simdray@example.com> (http://simdray.example.com)") を
使用することもできます。いずれの形式でも、email パラメーターおよび url パラメーターは
オプションです。owners パラメーターを指定しなければ、
公開されたアセットの所有者は、構成ファイルに指定されたユーザーに
設定されます。
- タイプ (type)
- type パラメーターは、
Rational Asset Manager でアセット・タイプを設定するために使用されます。
type パラメーターを指定しない場合、Implementation が
type パラメーターとして想定されます。
- 依存関係
- dependencies パラメーターは、
このパッケージが依存するその他のパッケージを記述する情報の配列のことです。
パッケージ ID は必須です。バージョン番号または照会ストリングはオプションです。
特定の状態のアセットを検索するには、照会ストリングの state:(state_name) を
使用します。ID を検索するには照会ストリングの id:(ID) を
使用します。Rational Asset Manager 検索ショートカットを
照会ストリングとして使用することもできます (例: ramSearch:(1txt%2Ckeyword))。
検索ショートカットは、Rational Asset Manager で
検索後に「検索のショートカットを表示」アイコンをクリックすることで取得できます。
以下の表は、Maven POM ファイル・パラメーターが
どのように
package.json ファイル・パラメーターにマッピングされるかを示しています。
| package.json ファイル・パラメーター |
Maven POM ファイル・パラメーター |
| id |
artifactId |
| version |
version |
| description |
description |
| タイプ (type) |
適用外。POM ファイルを使用して公開する場合、タイプは
Implementation に設定されます。 |
| 所有者 |
contributor |
| 依存関係 |
適用外。 |
package.json ファイルの例
{
"id": "jke",
"version": "2.1.0-SNAPSHOT",
"description": "Provides checking account services.",
"owners" : [
{ "name" : "Bill Jordan", "email" : "bjordan@example.com" } ,
{ "name" : "Lisa Starky", "email" : "lstarky@example.com" }
],
"type" : "implementation",
"dependencies": [
{ "id" : "JKE_infra", "version" : "2.1-SNAPSHOT" } ,
{ "id" : "devops_cookbooks-3.0", "query" : "state:(ready for verification)" }
]
}
ram publish newpackage.zip