GitHub action to publish allure report in cloud provider of choice using allure-report-publisher
By default this action will upload a test report to cloud provider bucket and add test result summary and link to report in the job summary
storageType
: required: true
, Cloud storage type (s3/gcp)resultsGlob
: required: true
, Allure results files glob patternbucket
: required: true
, Bucket nameprefix
: required: false
, Optional prefix for report path as stored in the bucket, default: none
baseUrl
: required: false
, Custom base url for report link, example: http://my-custom-url
, default: none
updatePr
: required: false
, Add report url and test result to pr or actions summary (comment/description/actions), default: actions
summary
: required: false
, Additionally add summary table of test results (behaviors/suites/packages/total), default: total
summaryTableType
: required: false
, Summary table type (ascii/markdown), default: markdown
collapseSummary
: required: false
, Create summary table as a collapsable section, default: false
reportTitle
: required: false
, Custom report title, default: Allure Report
copyLatest
: required: false
, Keep copy of latest report at base prefix path (static url to latest test execution), default: false
ignoreMissingResults
: required: false
, Ignore missing allure results and exit with 0 status code, default: false
flakyWarningStatus
: required: false
, Use '!' status emoji when flaky tests are present in report, default: false
color
: required: false
, Force color output, default: true
debug
: required: false
, Add debug log output, default: false
parallel
: required: false
, Number of parallel threads to use for report file upload to cloud storage, default: 8
reportName
: required: false
, Custom report name, default: Test Report
Action requires 2 environment variables to be set up
Github auth token for pull request updates if updatePr
is set to comment
or description
env:
GITHUB_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Depending on cloud provider used, one of the environment variables for authentication has to be set:
env:
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
env:
GOOGLE_CLOUD_CREDENTIALS_JSON: ${{ secrets.GOOGLE_CLOUD_CREDENTIALS_JSON }}
steps:
- name: Publish allure report
uses: andrcuns/allure-publish-action@v2.7.1
env:
GOOGLE_CLOUD_CREDENTIALS_JSON: ${{ secrets.GOOGLE_CLOUD_CREDENTIALS_JSON }}
GITHUB_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
storageType: gcs
resultsGlob: "path/to/allure-results"
bucket: allure-test-reports
prefix: $GITHUB_REF
copyLatest: true
ignoreMissingResults: true