Microsoft Visual SourceSafe タスク ユーザーマニュアル

作成者


目次


はじめに

これらのタスクは、Microsoft Visual SourceSafe SCMへのインターフェースを提供します。 org.apache.tools.ant.taskdefs.optional.vss パッケージは、VSS機能をサポートするためのシンプルなフレームワークと、頻繁に使用されるVSSコマンドをカプセル化したいくつかのApache Antタスクで構成されています。これらのコマンドはデスクトップで使用することもできますが、主に自動ビルドシステムで使用することを目的としています。

実行時に CreateProcess error=2 が発生した場合は、ss.exe が見つからないことを意味します。コマンドラインから実行できるかどうかを確認してください。パスを変更するか、ssdir プロパティを設定する必要がある場合があります。

タスク

タスク説明
vssget 指定されたVSSファイルのコピーを取得します。
vsslabel 指定されたバージョンまたはファイルまたはプロジェクトの現在のバージョンにラベルを割り当てます。
vsshistory VSSのファイルまたはプロジェクトの履歴を表示します。
vsscheckin チェックアウトされたファイルに加えられた変更でVSSを更新し、VSSマスターコピーのロックを解除します。
vsscheckout 編集するために、現在のプロジェクトから現在のフォルダにファイルをコピーします。
vssadd VSSアーカイブに新しいファイルを追加します
vsscp VSSで使用されている現在のプロジェクトを変更します
vsscreate VSSにプロジェクトを作成します。

タスクの説明

VssGet

説明

Microsoft Visual SourceSafeに対してGETコマンドを実行するタスク。

version、date、labelの属性を2つ以上指定した場合、version、date、labelの順序で1つだけ使用されます。

パラメータ

属性 必須
vsspath アクションを実行するプロジェクト/ファイルを指定するSourceSafeパス。 はい
login username[,password]—VSSへのアクセスに必要なユーザー名とパスワード。パスワードがある場合は両方指定する必要がある場合があります。パスワードを省略し、VSSがパスワードなしのログインを受け入れない場合、Ant/VSSはハングします。 いいえ
localpath 作業ディレクトリをオーバーライドし、指定されたパスを取得します いいえ
ssdir ss.exe が存在するディレクトリ。 いいえ; デフォルトではPATHにあると想定されます
serverPath srcsafe.ini が存在するディレクトリ。 いいえ
writable true|false いいえ; デフォルトはfalse
recursive true|false。ただし、SourceSafe UIには、ツール/オプション/全般タブからアクセスできるプロジェクトに再帰的に作用するという設定があります。この設定がオンになっている場合、recursive 属性は事実上無視され、getは常に再帰的に実行されます いいえ; デフォルトはfalse
version 取得するバージョン番号 いいえ; これらのうち1つだけ使用できます
date 取得する日付スタンプ
label 取得するラベル
quiet 出力を抑制する いいえ; デフォルトはoff
autoresponse 応答内容(-I オプションを設定)。デフォルトでは、-I- が使用されます。Y または N の値が追加されます。 いいえ
writablefiles ローカルファイルが書き込み可能になった場合の動作。有効なオプションは、replaceskipfail です。skipfailonerror=false を意味します いいえ; デフォルトはfail
failonerror ss.exe がリターンコード 100 で終了した場合、ビルドプロセスを停止します いいえ; デフォルトはtrue
filetimestamp ローカルファイルのタイムスタンプの動作を設定します。有効なオプションは、currentmodified、または updated です。 いいえ; デフォルトはcurrent

version、date、labelのいずれか1つのみを指定する必要があることに注意してください

ユーザー名 me とパスワード mypassword を使用して、VSSプロジェクト $/source/myproject に対してgetを実行します。これにより、Release1 というラベルが付いたファイルが再帰的に取得され、ローカルディレクトリ C:\mysrc\myproject に書き込まれます。ローカルファイルは書き込み可能になります。

<vssget localPath="C:\mysrc\myproject"
        recursive="true"
        label="Release1"
        login="me,mypassword"
        vsspath="$/source/aProject"
        writable="true"/>

VssLabel

説明

Microsoft Visual SourceSafeに対してLABELコマンドを実行するタスク。

指定されたバージョンまたはファイルまたはプロジェクトの現在のバージョンにラベルを割り当てます。

パラメータ

属性 必須
vsspath アクションを実行するプロジェクト/ファイルを指定するSourceSafeパス。 はい
login username[,password]—VSSへのアクセスに必要なユーザー名とパスワード。パスワードがある場合は両方指定する必要がある場合があります。パスワードを省略し、VSSがパスワードなしのログインを受け入れない場合、Ant/VSSはハングします。 いいえ
ssdir ss.exe が存在するディレクトリ。 いいえ; デフォルトではPATHにあると想定されます
serverPath srcsafe.ini が存在するディレクトリ。 いいえ
label 階層に適用するラベル はい
version ラベルを付ける既存のファイルまたはプロジェクトのバージョン。デフォルトでは、現在のバージョンにラベルが付けられます。 いいえ
comment このラベルに使用するコメント。空または - の場合はコメントなし。 いいえ
autoresponse 応答内容(-I オプションを設定)。デフォルトでは、-I- が使用されます。Y または N の値が追加されます。 いいえ
failonerror ss.exe がリターンコード 100 で終了した場合、ビルドプロセスを停止します。 いいえ; デフォルトはtrue

ユーザー名 me とパスワード mypassword を使用して、VSSプロジェクト $/source/aProject の現在のバージョンに Release1 というラベルを付けます。

<vsslabel vsspath="$/source/aProject"
          login="me,mypassword"
          label="Release1"/>

VSSファイル $/source/aProject/myfile.txt のバージョン4に 1.03.004 というラベルを付けます。このバージョンに既にラベルが付いている場合、操作(およびビルド)は失敗します。

<vsslabel vsspath="$/source/aProject/myfile.txt"
          version="4"
          label="1.03.004"/>

VssHistory

説明

Microsoft Visual SourceSafeに対してHISTORYコマンドを実行するタスク。

パラメータ

属性 必須
vsspath アクションを実行するプロジェクト/ファイルを指定するSourceSafeパス。 はい
login username[,password]—VSSへのアクセスに必要なユーザー名とパスワード。パスワードがある場合は両方指定する必要がある場合があります。パスワードを省略し、VSSがパスワードなしのログインを受け入れない場合、Ant/VSSはハングします。 いいえ
ssdir ss.exe が存在するディレクトリ。 いいえ; デフォルトではPATHにあると想定されます
serverPath srcsafe.ini が存在するディレクトリ。 いいえ
fromDate 比較の開始日 下記参照
toDate 比較の終了日 下記参照
dateFormat fromDate および toDate の日付の形式。numdays 属性を使用して日付を計算するときに使用されます。この文字列は、SimpleDateFormatの書式設定ルールを使用します。 いいえ; デフォルトは DateFormat.SHORT
fromLabel 比較の開始ラベル いいえ
toLabel 比較の開始ラベル いいえ
比較の終了ラベル numdays 下記参照
比較の日数。 output いいえ
recursive true|false いいえ
差分を書き込むファイル。 style briefcodediffdefault、または nofile
いいえ; デフォルトはdefault user いいえ
failonerror ss.exe がリターンコード 100 で終了した場合、ビルドプロセスを停止します いいえ; デフォルトはtrue

変更を確認したいユーザーの名前

期間の指定

特定の日付のX日後の変更:fromDatenumDays を指定します

<vsshistory vsspath="$/myProject" recursive="true"
            fromLabel="Release1"
            toLabel="Release2"/>

Release1Release2 の間のすべての変更を表示します。

<vsshistory vsspath="$/myProject" recursive="true"
            fromDate="01.01.2001"
            toDate="31.03.2001"/>

2001年1月1日から2001年3月31日までのすべての変更を表示します(ドイツでは、日付はロケールに従って指定する必要があります)。

<tstamp>
  <format property="to.tstamp" pattern="M-d-yy;h:mma"/>
</tstamp>

<vsshistory vsspath="$/myProject" recursive="true"
            numDays="-14"
            dateFormat="M-d-yy;h:mma"
            toDate="${to.tstamp}"/>

過去2週間のすべての変更を表示します。

説明

VssCheckin

パラメータ

属性 必須
vsspath アクションを実行するプロジェクト/ファイルを指定するSourceSafeパス。 はい
login username[,password]—VSSへのアクセスに必要なユーザー名とパスワード。パスワードがある場合は両方指定する必要がある場合があります。パスワードを省略し、VSSがパスワードなしのログインを受け入れない場合、Ant/VSSはハングします。 いいえ
localpath 作業ディレクトリをオーバーライドし、指定されたパスを取得します いいえ
ssdir ss.exe が存在するディレクトリ。 いいえ; デフォルトではPATHにあると想定されます
serverPath srcsafe.ini が存在するディレクトリ。 いいえ
writable true|false いいえ
recursive true|false いいえ
comment Microsoft Visual SourceSafeに対してCHECKINコマンドを実行するタスク。 いいえ
autoresponse チェックインされたファイルに使用するコメント。 いいえ
failonerror ss.exe がリターンコード 100 で終了した場合、ビルドプロセスを停止します。 いいえ; デフォルトはtrue

YN、または空。VSSからの質問にどのように回答するかを指定します。

<vsscheckin vsspath="$/test/test*"
            localpath="D:\build\"
            comment="Modified by automatic build"/>

ローカルディレクトリ D:\build を使用して、プロジェクト $/test 内の test* という名前のファイルをチェックインします。

説明

VssCheckout

Microsoft Visual SourceSafeに対してCHECKOUTコマンドを実行するタスク。

パラメータ

属性 必須
vsspath アクションを実行するプロジェクト/ファイルを指定するSourceSafeパス。 はい
login username[,password]—VSSへのアクセスに必要なユーザー名とパスワード。パスワードがある場合は両方指定する必要がある場合があります。パスワードを省略し、VSSがパスワードなしのログインを受け入れない場合、Ant/VSSはハングします。 いいえ
localpath 作業ディレクトリをオーバーライドし、指定されたパスを取得します いいえ
ssdir ss.exe が存在するディレクトリ。 いいえ; デフォルトではPATHにあると想定されます
serverPath srcsafe.ini が存在するディレクトリ。 いいえ
writable true|false いいえ
recursive true|false いいえ
version 取得するバージョン番号 いいえ; これらのうち1つだけ使用できます
date 取得する日付スタンプ
label 取得するラベル
writablefiles ローカルファイルが書き込み可能になった場合の動作。有効なオプションは、replaceskipfail です。skipfailonerror=false を意味します いいえ; デフォルトはfail
failonerror ss.exe がリターンコード 100 で終了した場合、ビルドプロセスを停止します。 いいえ; デフォルトはtrue
filetimestamp ローカルファイルのタイムスタンプの動作を設定します。有効なオプションは、currentmodified、または updated です。 いいえ; デフォルトはcurrent
versiondatelabel の属性を2つ以上指定した場合、versiondatelabel の順序で1つだけ使用されます。 getlocalcopy いいえ; デフォルトはtrue

ファイルのローカルコピーを取得するように動作を設定します。

<vsscheckout vsspath="$/test"
             localpath="D:\build"
             recursive="true"
             login="me,mypass"/>

プロジェクト $/test をディレクトリ D:\build に再帰的にチェックアウトします。

説明

VssAdd

パラメータ

属性 必須
localpath Microsoft Visual SourceSafeに対してADDコマンドを実行するタスク。 はい
login username[,password]—VSSへのアクセスに必要なユーザー名とパスワード。パスワードがある場合は両方指定する必要がある場合があります。パスワードを省略し、VSSがパスワードなしのログインを受け入れない場合、Ant/VSSはハングします。 いいえ
ssdir ss.exe が存在するディレクトリ。 いいえ; デフォルトではPATHにあると想定されます
serverPath srcsafe.ini が存在するディレクトリ。 いいえ
writable true|false いいえ
recursive true|false いいえ
comment Microsoft Visual SourceSafeに対してCHECKINコマンドを実行するタスク。 いいえ
autoresponse チェックインされたファイルに使用するコメント。 いいえ
failonerror ss.exe がリターンコード 100 で終了した場合、ビルドプロセスを停止します。 いいえ; デフォルトはtrue

VSSに追加するローカルファイルを指定します

<vssadd localpath="D:\build\build.00012.zip"
        comment="Added by automatic build"/>

build.00012.zip という名前のファイルを、現在の作業ディレクトリ(vsscp を参照)のプロジェクトに追加します。

説明

VssCp

Microsoft Visual SourceSafeに対してCP(Change Project)コマンドを実行するタスク。

パラメータ

属性 必須
vsspath このタスクは通常、ターゲットプロジェクトを設定するために VssAdd の前に使用されます はい
login username[,password]—VSSへのアクセスに必要なユーザー名とパスワード。パスワードがある場合は両方指定する必要がある場合があります。パスワードを省略し、VSSがパスワードなしのログインを受け入れない場合、Ant/VSSはハングします。 いいえ
ssdir ss.exe が存在するディレクトリ。 いいえ; デフォルトではPATHにあると想定されます
serverPath srcsafe.ini が存在するディレクトリ。 いいえ
failonerror ss.exe がリターンコード 100 で終了した場合、ビルドプロセスを停止します。 いいえ; デフォルトはtrue

現在のプロジェクトにするプロジェクトを指定するSourceSafeパス。

<vsscp vsspath="$/Projects/ant"/>

現在のVSSプロジェクトを $/Projects/ant に設定します。

説明

VssCreate

Microsoft Visual SourceSafeに対してCREATEコマンドを実行するタスク。

パラメータ

属性 必須
login VSSに新しいプロジェクトを作成します。 いいえ
vsspath username,password はい
ssdir ss.exe が存在するディレクトリ。 いいえ; デフォルトではPATHにあると想定されます
quiet 出力を抑制する いいえ; デフォルトはoff
作成されるプロジェクトのSourceSafeパス failOnError いいえ; デフォルトはtrue
autoresponse 応答内容(-I オプションを設定)。デフォルトでは、-I- が使用されます。Y または N の値が追加されます。 いいえ
comment このラベルに使用するコメント。空または - の場合はコメントなし。 いいえ

プロジェクトの作成中にエラーが発生した場合に失敗します。

<vsscreate vsspath="$/existingProject/newProject"/>