AxeWatcherGitInfo クラス

この AxeWatcherGitInfo クラスは、axe Watcher テスト実行の明示的な Git メタデータを保持します。インスタンスを setGitInfo() に渡して、自動 Git 検出を回避します。 AxeWatcherOptions

次のような場合にこのクラスを使用します:

• テストが対象のリポジトリとは別のリポジトリで実行される場合
• CI 環境で Git バイナリが利用できない場合
• リポジトリが浅いクローン、またはデタッチされた HEAD 状態の場合

branch commitShaを強く推奨します。全ての要素が揃わないと、テスト実行はAxe Developer Hub内のブランチまたはコミットの一覧に表示されません。残りのフィールドはオプションです。詳細は url はgitfulフィールドです。3つすべてが揃っていない状態で提出されたセッションは、 gitless として記録され保存されますが、Axe Developer Hubはgitlessセッションビューに切り替わり、以前のセッションのブランチとコミット履歴は見えなくなります。3つすべてのフィールドを揃えた後のセッションの提出で、gitfulビューが復元されます。3つのうち1つまたは2つのみが存在する場合、Axe Watcherはすべてのgitfulフィールドを削除し、セッションをgitlessとして記録し、応答に警告を含めます。残りのフィールドはオプションです。参照してください。 Gitメタデータの提供 の使用例を参照してください。

コンストラクタ

AxeWatcherGitInfo()

全フィールドが未設定の新しいインスタンスを作成します。

AxeWatcherGitInfo gitInfo = new AxeWatcherGitInfo();

メソッド

setBranch(String branch)

Git ブランチ名を設定します。テスト実行を Axe Developer Hub 上のブランチとコミットにリンクするために必要です。

パラメータ:

• branch - ブランチ名, 例: "main"

戻り値：

• AxeWatcherGitInfo - メソッドチェーン用の現在のインスタンス

例:

new AxeWatcherGitInfo().setBranch(System.getenv("GIT_BRANCH"));

setTag(String tag)

Git タグを設定します。

パラメータ:

• tag - タグ名, 例: "v1.2.3"

戻り値：

• AxeWatcherGitInfo - メソッドチェーン用の現在のインスタンス

例:

new AxeWatcherGitInfo().setTag(System.getenv("GIT_TAG"));

setDefaultBranch(String defaultBranch)

リポジトリのデフォルトブランチを設定します。このフィールドがないと、Axe Developer Hub はデフォルトのブランチを識別できないため、デフォルトブランチに対するフィーチャーブランチの比較が利用できなくなります。

パラメータ:

• defaultBranch - デフォルトブランチ名, 例: "main"

戻り値：

• AxeWatcherGitInfo - メソッドチェーン用の現在のインスタンス

例:

new AxeWatcherGitInfo().setDefaultBranch("main");

setCommitSha(String commitSha)

コミット SHA を設定します。テスト実行を Axe Developer Hub 上のブランチとコミットにリンクするために必要です。

パラメータ:

• commitSha - 完全または省略されたコミットハッシュ, 例: "abc1234"

戻り値：

• AxeWatcherGitInfo - メソッドチェーン用の現在のインスタンス

例:

new AxeWatcherGitInfo().setCommitSha(System.getenv("GIT_COMMIT"));

setCommitAuthor(String commitAuthor)

コミット作者の表示名を設定します。省略した場合、Axe Developer Hubで作者は未設定として表示されます。

パラメータ:

• commitAuthor - 作者の表示名

戻り値：

• AxeWatcherGitInfo - メソッドチェーン用の現在のインスタンス

例:

new AxeWatcherGitInfo().setCommitAuthor(System.getenv("GIT_AUTHOR_NAME"));

setCommitEmail(String commitEmail)

コミット作者のメールアドレスを設定します。

パラメータ:

• commitEmail - 作者のメールアドレス

戻り値：

• AxeWatcherGitInfo - メソッドチェーン用の現在のインスタンス

例:

new AxeWatcherGitInfo().setCommitEmail(System.getenv("GIT_AUTHOR_EMAIL"));

setCommitMessage(String commitMessage)

完全なコミットメッセージを設定します。省略した場合、Axe Developer Hubでコミットメッセージは未設定として表示されます。

パラメータ:

• commitMessage - 完全なコミットメッセージ

戻り値：

• AxeWatcherGitInfo - メソッドチェーン用の現在のインスタンス

例:

new AxeWatcherGitInfo().setCommitMessage(System.getenv("GIT_COMMIT_MESSAGE"));

setUrl(String url)

リポジトリのリモートURLを設定します。Axe Developer Hubでテスト実行がブランチとコミットにリンクされるために必要です。

パラメータ:

• url - リモートURL、例: "https://github.com/org/repo"

戻り値：

• AxeWatcherGitInfo - メソッドチェーン用の現在のインスタンス

例:

new AxeWatcherGitInfo().setUrl("https://github.com/org/repo");

setIsDirty(boolean isDirty)

作業ツリーにコミットされていない変更があるかどうかを設定します。 true 変更がある場合、あるいは false 作業ツリーがクリーンな場合にはfalseこのメソッドを呼び出さない場合、作業ツリーはクリーンとして報告されます（

パラメータ:

• isDirty - true コミットされていない変更がある場合

戻り値：

• AxeWatcherGitInfo - メソッドチェーン用の現在のインスタンス

例:

new AxeWatcherGitInfo().setIsDirty(true);

getBranch()

戻り値： String - ブランチ名、または null が設定されていない場合。

getTag()

戻り値： String - タグ、または null が設定されていない場合。

getDefaultBranch()

戻り値： String - デフォルトのブランチ名、または null が設定されていない場合。

getCommitSha()

戻り値： String - コミットSHA、または null が設定されていない場合。

getCommitAuthor()

戻り値： String - コミット作者の表示名、または null が設定されていない場合。

getCommitEmail()

戻り値： String - コミット作者のメールアドレス、または null が設定されていない場合。

getCommitMessage()

戻り値： String - コミットメッセージ、または null が設定されていない場合。

getUrl()

戻り値： String - リポジトリのリモートURL、または null が設定されていない場合。

getIsDirty()

戻り値： Boolean - true 変更があれば、 false 状態がクリーンなら、または null が setIsDirty() 呼び出されていない場合。

関連項目

• AxeWatcherOptions
• AxeWatcher
• Gitメタデータの提供