https://github.com/allure-framework/allure-action
https://github.com/allure-framework/allure-action
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/allure-framework/allure-action
- Owner: allure-framework
- Created: 2025-06-11T12:33:49.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2026-01-12T14:35:26.000Z (6 months ago)
- Last Synced: 2026-01-12T17:52:09.696Z (6 months ago)
- Language: TypeScript
- Size: 406 MB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Allure Action
> GitHub action to render Allure Report summary right in your Pull Requests
[
](https://allurereport.org "Allure Report")
- Learn more about Allure Report at https://allurereport.org
- 📚 [Documentation](https://allurereport.org/docs/) – discover official documentation for Allure Report
- ❓ [Questions and Support](https://github.com/orgs/allure-framework/discussions/categories/questions-support) – get help from the team and community
- 📢 [Official annoucements](https://github.com/orgs/allure-framework/discussions/categories/announcements) – be in touch with the latest updates
- 💬 [General Discussion ](https://github.com/orgs/allure-framework/discussions/categories/general-discussion) – engage in casual conversations, share insights and ideas with the community
---
## Overview
This actions scans given report directory for data and posts a summary comment that includes:
- Summary statistics about all test results
- New, flaky and retry tests
- Adds remote report link if the report has been published to the Allure Service
## Usage
Add `pull-requests` and `checks` permissions to your workflow to make possible posting comments to Pull Requests:
```yaml
permissions:
pull-requests: write
checks: write
```
Then, add the action to your workflow right after your tests, which produce Allure Report:
```yaml
- name: Run tests
run |-
# run your tests that generate Allure Report data
- name: Run Allure Action
uses: allure-framework/allure-report@v0
with:
# Path to the generated report directory
# By default, it's set to `./allure-report`
report-directory: "./"
# Github Token that uses for posting the comments in Pull Requests
github-token: ${{ secrets.GITHUB_TOKEN }}
```
If everything is set up correctly and required reports data is present, the Action will post a comment with Allure Report summary to your Pull Request, like this:
## Configuration
The action utilizes Allure 3 Runtime configuration file (`allurerc.js` or `allurerc.mjs`) and use `output` field as a path, where it should search for the generated reports.
### Remote reports
If you want to be able to open remote reports automatically hosted on Allure Service, provide `allureService` configuration to the `allurerc.js` configuration file:
```diff
import { defineConfig } from "allure";
import { env } from "node:process";
export default defineConfig({
output: "allure-report",
+ allureService: {
+ url: env.ALLURE_SERVICE_URL,
+ project: env.ALLURE_SERVICE_PROJECT,
+ accessToken: env.ALLURE_SERVICE_ACCESS_TOKEN,
+ }
});
```