@allurereport/plugin-log

Log Plugin

• Learn more about Allure Report at https://allurereport.org
• Documentation – discover official documentation for Allure Report
• Questions and Support – get help from the team and community
• Official announcements – be in touch with the latest updates
• General Discussion – engage in casual conversations, share insights and ideas with the community

Overview

This plugin prints report in the terminal.

Install

Use your favorite package manager to install the package:

npm add @allurereport/plugin-log
yarn add @allurereport/plugin-log
pnpm add @allurereport/plugin-log

Then, add the plugin to the Allure configuration file:

import { defineConfig } from "allure";

export default defineConfig({
  name: "Allure Report",
  output: "./allure-report",
  historyPath: "./history.jsonl",
  plugins: {
+    log: {
+      options: {
+      },
+    },
  },
});

Options

The plugin accepts the following options:

To show both successful and failed quality gate checks, configure the filter to include every result:

export default {
  plugins: {
    log: {
      options: {
        qualityGateFilter: () => true,
      },
    },
  },
};

For allure log, use the --all-quality-gate-results flag to include successful quality gate checks. The command constructs its own log plugin configuration for that run, so plugin configuration from the Allure config file is not applied to allure log.