Fornire Metadati Git

Axe Watcher collega i risultati dell'accessibilità al commit Git che è stato testato, permettendoti di tracciare i problemi attraverso rami e build nell'Axe Developer Hub. Per impostazione predefinita, Watcher raccoglie queste informazioni automaticamente utilizzando il binario Git locale. Puoi anche disabilitare completamente la raccolta o fornire tu stesso i metadati.

Raccolta Automatica (Predefinita)

Quando non viene fornita alcuna git configurazione, Watcher rileva automaticamente il ramo corrente, lo SHA del commit, l'autore e altri campi Git dal repository locale. Non è richiesta alcuna configurazione aggiuntiva.

Disabilitare la Raccolta Git

Se il tuo ambiente non dispone di un binario Git, o se non vuoi che i dati Git siano associati a un'esecuzione di test, puoi disabilitare completamente la raccolta.

(JavaScript/TypeScript) Imposta la proprietà git a false nel tuo AxeConfiguration:

axe: {
  apiKey: process.env.AXE_DEVELOPER_HUB_API_KEY,
  projectId: process.env.AXE_DEVELOPER_HUB_PROJECT_ID,
  git: false
}

(Java) Chiama setGit(false) nel tuo AxeWatcherOptions:

AxeWatcherOptions options = new AxeWatcherOptions()
    .setApiKey(System.getenv("AXE_DEVELOPER_HUB_API_KEY"))
    .setProjectId(System.getenv("AXE_DEVELOPER_HUB_PROJECT_ID"))
    .setGit(false);

Fornire Metadati Espliciti

Alcune configurazioni CI eseguono test in un repository QA dedicato separato dal repository sotto test. In questi casi, l'auto-rilevamento raccoglierebbe i metadati dal repository QA anziché dal repository di codice, producendo risultati fuorvianti nell'Axe Developer Hub. Devi fornire esplicitamente i metadati corretti.

I metadati espliciti sono utili anche quando l'auto-rilevamento è inaffidabile, per esempio, in cloni superficiali o quando il repository è in uno stato staccato (detached HEAD).

I seguenti campi sono disponibili. branch, commitSha, e url sono i campi gitful: una sessione inviata senza tutti e tre viene registrata come gitless e salvata, ma Axe Developer Hub passa alla vista della sessione gitless, dove i dati sui branch e la cronologia dei commit delle sessioni precedenti non saranno visibili. L'invio di una successiva sessione con tutti e tre i campi ripristina la vista gitful. Se solo uno o due dei tre sono presenti, Axe Watcher elimina tutti i campi gitful, registra la sessione come gitless e include un avviso nella risposta. I campi rimanenti sono opzionali.

(JavaScript/TypeScript) Passa un GitConfig oggetto alla proprietà git nel tuo AxeConfiguration. I nomi specifici delle variabili d'ambiente dipendono dalla tua piattaforma CI:

axe: {
  apiKey: process.env.AXE_DEVELOPER_HUB_API_KEY,
  projectId: process.env.AXE_DEVELOPER_HUB_PROJECT_ID,
  git: {
    commitSha: process.env.GIT_COMMIT,
    branch: process.env.GIT_BRANCH,
    url: process.env.GIT_URL,
    commitAuthor: process.env.GIT_AUTHOR_NAME,
    commitEmail: process.env.GIT_AUTHOR_EMAIL,
    commitMessage: process.env.GIT_COMMIT_MESSAGE,
    defaultBranch: 'main'
  }
}

(Java) Crea un'istanza di AxeWatcherGitInfo e passa a setGitInfo() nel tuo AxeWatcherOptions:

AxeWatcherOptions options = new AxeWatcherOptions()
    .setApiKey(System.getenv("AXE_DEVELOPER_HUB_API_KEY"))
    .setProjectId(System.getenv("AXE_DEVELOPER_HUB_PROJECT_ID"))
    .setGitInfo(new AxeWatcherGitInfo()
        .setCommitSha(System.getenv("GIT_COMMIT"))
        .setBranch(System.getenv("GIT_BRANCH"))
        .setUrl(System.getenv("GIT_URL"))
        .setCommitAuthor(System.getenv("GIT_AUTHOR_NAME"))
        .setCommitEmail(System.getenv("GIT_AUTHOR_EMAIL"))
        .setCommitMessage(System.getenv("GIT_COMMIT_MESSAGE"))
        .setDefaultBranch("main"));

Vedi Anche

• (JavaScript/TypeScript) AxeConfiguration.git
• (Java) AxeWatcherOptions.setGitInfo()
• (Java) AxeWatcherGitInfo
• Utilizza Axe Watcher in ambienti di Continuous Integration (CI)