AxeWatcherGitInfo ク ラス
自動検出が利用できない場合、または信頼できない場合に明示的に Git メタデータを提供
このAxeWatcherGitInfoクラスは、Axe Watcherテスト実行のための明示的なGitメタデータを保持します。setGitInfo()上でAxeWatcherOptionsにインスタンスを渡すことで、Gitの自動検出をバイパスできます。
次のような場合にこのクラスを使用します:
- テストが対象のリポジトリとは別のリポジトリで実行される場合
- CI 環境で Git バイナリが利用できない場合
- リポジトリが浅いクローン、またはデタッチされた HEAD 状態の場合
branch、commitSha、および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、またはsetIsDirty()が未呼び出しの場合はnull。