allure-report-action
allure-report-action copied to clipboard
Allure Report action with history
Allure Report with history action
Generates Allure Report with history.
Example workflow file allure-report
Inputs
allure_results
Required The relative path to the Allure results directory.
Default allure-results
allure_report
Required The relative path to the directory where Allure will write the generated report.
Default allure-report
gh_pages
Required The relative path to the gh-pages branch folder. On first run this folder can be empty.
Also, you need to do a checkout of gh-pages branch, even it doesn't exist yet.
Default gh-pages
- name: Get Allure history
uses: actions/checkout@v2
if: always()
continue-on-error: true
with:
ref: gh-pages
path: gh-pages
allure_history
Required The relative path to the folder, that will be published to GitHub Pages.
Default allure-history
subfolder
The relative path to the project folder, if you have few different projects in the repository. This relative path also will be added to GitHub Pages link. Example project allure-examples.
Default ``
Example usage (local action)
- name: Test local action
uses: ./allure-report-action
if: always()
id: allure-report
with:
allure_results: build/allure-results
gh_pages: gh-pages
allure_report: allure-report
allure_history: allure-history
Example usage (github action)
- name: Test marketplace action
uses: simple-elf/allure-report-action@master
if: always()
id: allure-report
with:
allure_results: build/allure-results
gh_pages: gh-pages
allure_report: allure-report
allure_history: allure-history
Finally you need to publish on GitHub Pages
- name: Deploy report to Github Pages
if: always()
uses: peaceiris/actions-gh-pages@v2
env:
PERSONAL_TOKEN: ${{ secrets.GITHUB_TOKEN }}
PUBLISH_BRANCH: gh-pages
PUBLISH_DIR: allure-history
Also you can post the link to the report in the checks section
- name: Post the link to the report
if: always()
uses: Sibz/github-status-action@v1
with:
authToken: ${{secrets.GITHUB_TOKEN}}
context: 'Test report'
state: 'success'
sha: ${{ github.event.pull_request.head.sha }}
target_url: simple-elf.github.io/github-allure-history/${{ github.run_number }}