Allure Deployer Action
ActionsDeploy Allure reports with History, Retries, Aggregation and Slack integration
v1.9.6
LatestBy cybersokari
Host Allure reports on the web with History, Retries, Report Aggregation, and Slack integration.
Supported Deployment Targets:
- GitHub Pages
- Firebase Hosting
Supported Runners:
ubuntu-latestmacos-latestwindows-latestSelf-hosted runner. Ensure you have a Java runtime installed and firewall rules configured.
jobs:
gh-pages:
runs-on: ubuntu-latest
permissions:
contents: write
actions: write
steps:
- uses: actions/checkout@v4.1.5
- name: Run test
run: #Run test and create allure results
- name: Deploy Reports to GitHub pages with History and Retries
uses: cybersokari/allure-deployer-action@v1.8.0
with:
target: 'github'
github_pages_branch: 'gh-pages'
allure_results_path: 'allure-results'
show_history: 'true'
retries: 5Example test run: actions/runs/12783827755
jobs:
firebase:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4.1.5
- name: Run test
run: #Run test and create allure results
- name: Deploy Reports to Firebase with History and Retries
uses: cybersokari/allure-deployer-action@v1.8.0
with:
target: 'firebase'
allure_results_path: 'allure-results'
google_credentials_json: ${{ secrets.GOOGLE_APPLICATION_CREDENTIALS }}
gcs_bucket: ${{vars.STORAGE_BUCKET}}
show_history: 'true'
retries: 5Example test run: actions/runs/12783830022
on:
pull_request:
jobs:
allure-pr:
runs-on: ubuntu-latest
permissions:
contents: write
actions: write
pull-requests: write # For when `pr_comment` is `true`
issues: write # For when `pr_comment` is `true`
steps:
- uses: actions/checkout@v4.1.5
- name: Run test
run: #Run test and create allure results
- name: Deploy Reports to GitHub pages on Pull Request
uses: cybersokari/allure-deployer-action@v1.8.0
with:
pr_comment: 'true'
target: 'github'
allure_results_path: 'allure-results'
show_history: 'true'
retries: 5Pull request comment example
📊 Test Report: https://your-example-url.web.app
| ✅ Passed | ⚠️ Broken |
|----------|-----------|
| 15 | 2 || Name | Description | Default Value | Required? |
|---|---|---|---|
allure_results_path |
Path(s) to Allure results. Separate multiple paths with commas. | allure-results |
Yes |
target |
Deployment target: firebase or github. |
None | Yes |
google_credentials_json |
Firebase credentials to enable History, Retries, and Firebase Hosting. | None | No |
github_token |
GitHub token or personal access token to enable GitHub pages hosting and pr_comment |
github.token |
No |
report_name |
Custom name/title for the report. | None | No |
language |
Allure report language | en |
No |
gcs_bucket |
Google Cloud Storage bucket name for History and Retries when target is firebase. |
None | No |
show_history |
Display history from previous runs. | true |
No |
retries |
Number of previous runs to display as retries. | 0 | No |
custom_report_dir |
Directory to generate the Allure report in, if you want to use test report in subsequent steps. | None | No |
slack_channel |
Slack channel ID for report notifications. | None | No |
slack_token |
Slack app token for sending notifications. | None | No |
pr_comment |
Post report information as a pull request comment. Requires GitHub token with pull_requests: write and issues: write permissions |
true |
No |
github_pages_branch |
Branch used for GitHub Pages deployments. | gh-pages |
No |
github_pages_repo |
GitHub repository to deploy GitHub pages. Example owner/repository-nam | github.repository |
No |
prefix |
Prefix to uniquely identify test report artifacts when managing multiple projects. | None | No |
keep |
Number of test reports you want to keep alive. | 10 |
No |
| Name | Description |
|---|---|
report_url |
URL of the test report. |
- GitHub Pages Hosting:
- Ensure
github_tokenpermissions includecontents: writeandactions: writecontents: writepermission is used to push report files togithub_pages_branchactions: writeis used to back up Allure History and Retries as GitHub Artifacts.
- Ensure that GitHub Pages is configured to deploy from the
github_pages_branchprovided. Default branch isgh-pages
- Ensure
- Firebase Hosting:
Export a service account JSON file from your Firebase Console. - Pull Request Comments:
Ensuregithub_tokenpermissions includepull_requests: writeandissues: write. - Slack Integration:
Create a Slack app, and generate a token for notifications.
Looking for a developer with expertise in automation, DevOps, and test infrastructure? I'm available for consulting and freelance work.
- Skills: Mobile Test Automation (Appium, WebdriverIO), CI/CD, Docker, GitHub Actions, Firebase, and more.
- Experience: 8+ years in software engineering, building scalable automation solutions.
- Contact: Reach me via email at
sokariharry[at]gmail[dot]comor connect on LinkedIn.
Let's work together to improve your testing and deployment processes!
- License: BSD-3 License. See the License file for details.
- Contributing: Contributions are welcome! Open issues or submit pull requests to help improve this action.
Allure Deployer Action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
About
v1.9.6
LatestBy cybersokari
Allure Deployer Action is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.