Skip to content
bar-chart

GitHub Action

Allure Deployer Action

v1.1.8 Latest version

Allure Deployer Action

bar-chart

Allure Deployer Action

Host your Allure Reports on the web, with history, retries and Slack integration, No server required

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Allure Deployer Action

              
  uses: cybersokari/allure-deployer-action@v1.1.8
Learn more about this action in cybersokari/allure-deployer-action

Choose a version

Allure Deployer Action

Host your Allure Reports on the web with history, retries, and Slack notifications. No server required.

Example report: https://gatedaccessdev.web.app
See complete documentation for more info.

🚀 Features

  • Serverless hosting: Host your reports on the web, not storage.
  • History & Retries: Show history and retries in reports with history linking to previous reports.
  • Cloud Backup: Save test results in storage for future analysis.
  • Slack Notifications: Notify stakeholders with report URL and details.

🛠️ Inputs

Input Name Description Required Default
storage_bucket Google Cloud Storage bucket name. No None
report_name The name/title of your report. No Allure Report
slack_channel Slack channel ID for notifications. No None
allure_results_path Directory containing Allure results. Yes None
show_retries Display retries in the test report (true/false). No true
show_history Display historical data in the test report (true/false). No true

🔧 Environment Variables

Variable Description Required Example
SLACK_TOKEN Slack Bot API token for notifications. No xoxb-****
GCP_CREDENTIALS_JSON Firebase (Google Cloud) credentials JSON as a string, not a file path. Yes { "type": "service_account", ... }

📤 Outputs

Output Name Description
report_url URL of the deployed Allure test report.

📋 Example Usage

name: Allure Report Deployer
on:
  push:
    branches:
      - main
jobs:
  deploy-report:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Code
        uses: actions/checkout@v3

      - name: Run Allure Report Deployer
        uses: cybersokari/allure-deployer-action@v1
        with:
          storage_bucket: '<your_bucket_name>'
          allure_results_path: './allure-results'
          slack_channel: '<YOUR_SLACK_CHANNEL_ID>'
        env:
          GCP_CREDENTIALS_JSON: '${{ secrets.GCP_CREDENTIALS_JSON }}'
          SLACK_TOKEN: '${{ secrets.SLACK_TOKEN }}'

Environment Setup

## 🔧 Environment Setup
- **Firebase Account**: Ensure access to Firebase Hosting and Google Cloud Storage.
- **Google Cloud Credentials**: Set up a service account and download the JSON key file.
- **Slack Integration**: Optional. Create a Slack app for notifications and obtain its token.

📜 License

This project is licensed under the MIT License. See the LICENSE file for more details.

🤝 Contributing

Contributions are welcome! Open issues or submit pull requests to improve this action.