Files
backstage/plugins/allure
Patrik Oldsberg 51cced24b4 Merge pull request #11425 from sergeyshevch/feature/add-isallureavailable-helper-for-allure-plugin
feat: Add exports for allure plugin annotation helpers
2022-05-18 11:33:14 +02:00
..
2022-05-17 09:26:29 +00:00
2022-05-17 09:26:29 +00:00

Allure

Welcome to the Backstage Allure plugin. This plugin add an entity service page to display Allure test reports related to the service.

Install

Run the below command from the app package directory.

yarn add @backstage/plugin-allure

alternatively, you can execute below command from the root directory of your Backstage app.

yarn workspace app add @backstage/plugin-allure

Configure

Configure Allure service

Add below configuration in the app-config.yaml.

allure:
  baseUrl: <ALLURE_SERVICE_BASE_URL> # Example: https://allure.my-company.net or when running allure locally, http://localhost:5050/allure-docker-service

Setup entity service page

Add EntityAllureReportContent in the EntityPage.tsx like below:

+ import { EntityAllureReportContent } from '@backstage/plugin-allure';

...

const serviceEntityPage = (
  <EntityLayoutWrapper>
    ...
+    <EntityLayout.Route path="/allure" title="Allure Report">
+        <EntityAllureReportContent />
+    </EntityLayout.Route>
  </EntityLayoutWrapper>
);