https://github.com/firebolt-db/action-allure-report
GH Action to create Allure report on tests
https://github.com/firebolt-db/action-allure-report
Last synced: about 1 month ago
JSON representation
GH Action to create Allure report on tests
- Host: GitHub
- URL: https://github.com/firebolt-db/action-allure-report
- Owner: firebolt-db
- License: apache-2.0
- Created: 2023-04-27T16:05:48.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-07-12T15:51:45.000Z (11 months ago)
- Last Synced: 2025-04-29T21:18:37.653Z (about 1 month ago)
- Size: 23.4 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# action-allure-report
GH Action to create Allure report on tests.
This action requires github pages to be enabled.
## Inputs
### github-key
**Required:** [Github token](https://docs.github.com/en/actions/security-guides/automatic-token-authentication)
### test-type
Optional: Type of the test to distinguish when reporting. Integration or unit.
Default: unit
### allure-dir
Optional: Directory where allure report lives.
Default: allure-results
### pages-branch
Optional: Branch where GitHub Pages is deployed.
Default: gh-pages
## Example usage
First you need to make sure allure report is generated. Install language-appropriate allure extension for your test framework and run the tests.
In the following example adding `--alluredir=allure-results` enables Allure report generation.
```yml
- name: Run your tests
run: |
pytest tests/unit --alluredir=allure-results
# Need to pull the pages branch in order to fetch the previous runs
- name: Get Allure history
uses: actions/checkout@v2
if: always() # Needed in order to report failed tests
continue-on-error: true
with:
ref: gh-pages
path: gh-pages
- name: Allure Report
uses: firebolt-db/action-allure-report@main
if: always() # Needed in order to report failed tests
with:
github-key: ${{ secrets.GITHUB_TOKEN }}
# The rest of the inputs are optional
test-type: Unit
allure-dir: allure-results
paged-branch: gh-pages
```