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:false, Allure results files glob pattern, default:./**/allure-resultsbucket: required:true, Bucket nameprefix: required:false, Optional prefix for report path as stored in the bucket, default:nonebaseUrl: required:false, Custom base url for report link, example:http://my-custom-url, default:noneconfig: required:false, Path to custom allure configuration file, default:noneupdatePr: required:false, Add report url and test result to pr or actions summary (comment/description/actions), default:actionssummary: required:false, Additionally add summary table of test results, default:truecollapseSummary: required:false, Create summary table as a collapsible section, default:falsereportTitle: required:false, Custom report title for PR comment/description/actions section, default:Allure ReportcopyLatest: required:false, Keep copy of latest report at base prefix path (static url to latest test execution), default:falseignoreMissingResults: required:false, Ignore missing allure results and exit with 0 status code, default:falseflakyWarningStatus: required:false, Use '!' status emoji when flaky tests are present in report, default:falsecolor: required:false, Force color output, default:truedebug: required:false, Add debug log output, default:falseparallel: required:false, Number of parallel threads to use for report file upload to cloud storage, default:8reportName: required:false, Custom report name, default:Test Report
Action requires 2 environment variable types 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_APPLICATION_CREDENTIALS: ${{ secrets.GOOGLE_APPLICATION_CREDENTIALS }}steps:
- name: Publish allure report
uses: andrcuns/[email protected]
env:
AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
GITHUB_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
storageType: s3
resultsGlob: "path/to/allure-results"
bucket: allure-test-reports
prefix: $GITHUB_REF
copyLatest: true
ignoreMissingResults: trueallure-publish-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.