Clase AxeWatcherGitInfo

La clase AxeWatcherGitInfo contiene metadatos explícitos de Git para una ejecución de prueba de Axe Watcher. Pase una instancia a setGitInfo() en AxeWatcherOptions para omitir la detección automática de Git.

Use esta clase cuando:

• Sus pruebas se ejecuten en un repositorio separado del repositorio bajo prueba
• El binario de Git no esté disponible en su entorno de CI
• El repositorio sea un clon superficial o esté en un estado de HEAD separado

branch, commitSha y url son los campos gitful. Si el proyecto aún no se ha bloqueado a una forma de datos, una sesión enviada sin los tres se registra como Gitless, y el proyecto se bloquea a Gitless en adelante. Una vez que un proyecto está bloqueado a Git, una sesión que falte cualquiera de los tres campos es rechazada en la ingestión: los resultados no se guardan. Véase Ejecución rechazada: la forma de datos o el repositorio no coincide con el proyecto para el mensaje de rechazo y cómo resolverlo. Los campos restantes son opcionales.

Vea Proporcionando Metadatos de Git para ejemplos de uso. Un clon superficial o un estado de HEAD separado, mencionado anteriormente como una razón para usar esta clase, es también una causa común del rechazo: vea Ejecución rechazada: la forma de los datos o el repositorio no coincide con el proyecto.

Constructor

AxeWatcherGitInfo()

Crea una nueva instancia con todos los campos sin establecer.

AxeWatcherGitInfo gitInfo = new AxeWatcherGitInfo();

Métodos

setBranch(String branch)

Establece el nombre de la rama de Git. Necesario para que la ejecución de prueba esté vinculada a una rama y un commit en Axe Developer Hub.

Parámetros:

• branch - Nombre de la rama, por ejemplo, "main"

Devoluciones:

• AxeWatcherGitInfo - La instancia actual para el encadenamiento de métodos

Ejemplo:

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

setCommitAuthor(String commitAuthor)

Establece el nombre para mostrar del autor del commit. Si se omite, el autor aparece como no disponible en Axe Developer Hub.

Parámetros:

• commitAuthor - Nombre de visualización del autor

Devoluciones:

• AxeWatcherGitInfo - La instancia actual para el encadenamiento de métodos

Ejemplo:

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

setCommitEmail(String commitEmail)

Establece la dirección de correo electrónico del autor del commit.

Parámetros:

• commitEmail - Dirección de correo electrónico del autor

Devoluciones:

• AxeWatcherGitInfo - La instancia actual para el encadenamiento de métodos

Ejemplo:

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

setCommitMessage(String commitMessage)

Establece el mensaje completo del commit. Si se omite, el mensaje del commit aparece como no disponible en Axe Developer Hub.

Parámetros:

• commitMessage - El mensaje completo del commit

Devoluciones:

• AxeWatcherGitInfo - La instancia actual para el encadenamiento de métodos

Ejemplo:

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

setCommitSha(String commitSha)

Establece el SHA del commit. Necesario para que la ejecución de prueba esté vinculada a una rama y un commit en Axe Developer Hub.

Parámetros:

• commitSha - Hash de commit completo o abreviado, por ejemplo, "abc1234"

Devoluciones:

• AxeWatcherGitInfo - La instancia actual para el encadenamiento de métodos

Ejemplo:

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

setDefaultBranch(String defaultBranch)

Establece la rama predeterminada del repositorio. Sin este campo, Axe Developer Hub no puede identificar cuál es la rama predeterminada, por lo que las comparaciones de feature branch contra la rama predeterminada no estarán disponibles.

Parámetros:

• defaultBranch - Nombre de la rama predeterminada, por ejemplo, "main"

Devoluciones:

• AxeWatcherGitInfo - La instancia actual para el encadenamiento de métodos

Ejemplo:

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

setIsDirty(boolean isDirty)

Establece si el árbol de trabajo tiene cambios no confirmados. Configúrelo a true si hay cambios no confirmados, o a false si el árbol de trabajo está limpio. Si no llama a este método, el árbol de trabajo se reporta como limpio (false).

Parámetros:

• isDirty - true si hay cambios no confirmados

Devoluciones:

• AxeWatcherGitInfo - La instancia actual para el encadenamiento de métodos

Ejemplo:

new AxeWatcherGitInfo().setIsDirty(true);

setTag(String tag)

Establece la etiqueta de Git.

Parámetros:

• tag - Nombre de la etiqueta, por ejemplo, "v1.2.3"

Devoluciones:

• AxeWatcherGitInfo - La instancia actual para el encadenamiento de métodos

Ejemplo:

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

setUrl(String url)

Establece la URL remota del repositorio. Es necesario para que la ejecución de prueba esté vinculada a una rama y commit en Axe Developer Hub.

Parámetros:

• url - URL remota, por ejemplo, "https://github.com/org/repo"

Devoluciones:

• AxeWatcherGitInfo - La instancia actual para el encadenamiento de métodos

Ejemplo:

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

getBranch()

Devoluciones: String - El nombre de la rama, o null si no está establecido.

getCommitAuthor()

Devoluciones: String - El nombre de visualización del autor del commit, o null si no está establecido.

getCommitEmail()

Devoluciones: String - La dirección de correo electrónico del autor del commit, o null si no está establecida.

getCommitMessage()

Devoluciones: String - El mensaje del commit, o null si no está establecido.

getCommitSha()

Devoluciones: String - El SHA del commit, o null si no está establecido.

getDefaultBranch()

Devoluciones: String - El nombre de la rama predeterminada, o null si no está establecido.

getIsDirty()

Devoluciones: Boolean - true si está sucio, false si está limpio, o null si setIsDirty() nunca fue llamado.

getTag()

Devoluciones: String - La etiqueta, o null si no está establecida.

getUrl()

Devoluciones: String - La URL remota del repositorio, o null si no está establecida.

Ver También

• AxeWatcherOptions
• AxeWatcher
• Proporcionando Metadatos de Git