Skip to content

Allure remote history #151

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Open

Allure remote history #151

wants to merge 14 commits into from

Conversation

epszaw
Copy link
Member

@epszaw epszaw commented Apr 17, 2025

The PR provides an ability to use remote history served by Allure Service.

New config field allureService sets-up the project:

import { defineConfig } from "allure";

export default defineConfig({
  name: "Allure Report 3",
  output: "./out/allure-report",
  plugins: {
    awesome: {
      options: {
        singleFile: false,
        reportLanguage: "en",
        reportName: "Allure 3 Report",
      },
    },
  },
+  allureService: {
+    project: "allure3"
+  }
});

How to start using remote history

  1. Use allure login command to sign in into the Allure Service
image
  1. Once you're signed in, use allure whoami command to check, that you're using a correct account
image
  1. Run allure init command in the project root
image
  1. Insert code snipped from stdout to the config
  2. Run tests, the report's history now be uploaded and downloaded from the Allure Service automatically

Additional CLI commands to check

  • allure projects - renders projects list and allows picking one to get a code snippet to insert to the config
  • allure project-create – creates a new project
  • allure project-delete – deletes a project
  • allure logout – revokes current session

How to test the feature locally

  1. Start Allure Service locally
  2. Add the service url to the config:
import { defineConfig } from "allure";

export default defineConfig({
  name: "Allure Report 3",
  output: "./out/allure-report",
  plugins: {
    awesome: {
      options: {
        singleFile: false,
        reportLanguage: "en",
        reportName: "Allure 3 Report",
      },
    },
  },
  allureService: {
    project: "allure3",
+   url: "http://localhost:12345" // url your instance running on
  }
});
  1. Complete initial flow above

@epszaw epszaw changed the title History service API Allure service API Apr 20, 2025
@epszaw epszaw changed the title Allure service API Allure remote history Apr 30, 2025
@epszaw epszaw marked this pull request as ready for review April 30, 2025 11:53
@epszaw epszaw requested review from baev and delatrie April 30, 2025 17:19
@epszaw epszaw force-pushed the history-service branch from a294877 to 7626b70 Compare May 7, 2025 14:51
@epszaw epszaw force-pushed the history-service branch from 7626b70 to 0e954df Compare May 19, 2025 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant