Skip to content
monitor

GitHub Action

Allure Report with history per branch (JS)

v1.4.5 Latest version

Allure Report with history per branch (JS)

monitor

Allure Report with history per branch (JS)

Generate Allure Report with history per branch (JS)

Installation

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

 
              
- name: Allure Report with history per branch (JS)

              
  uses: mgrybyk-org/[email protected]
Learn more about this action in mgrybyk-org/allure-report-branch-js-action

Choose a version

allure-report-branch-js-action

A JavaScript version of the Allure Report with history per branch (type: node20)

Important: Requires java to be installed in prior to using the action!

Docker version of the action: allure-report-with-history-per-branch

See examples:

Compatible with HTML Trend Report Action.

Usage

  1. Enable Pages in your repository settings. Github Pages

  2. In your workflow yaml

permissions:
  contents: write

steps:
  - name: Checkout gh-pages
    uses: actions/checkout@v3
    if: always()
    continue-on-error: true
    with:
      ref: gh-pages # branch name
      path: gh-pages-dir # checkout path

  - name: Allure Report Action
    uses: mgrybyk-org/allure-report-branch-js-action@v1
    if: always()
    continue-on-error: true
    id: allure # used in comment to PR
    with:
      report_id: 'self-test'
      gh_pages: 'gh-pages-dir'
      report_dir: 'allure-results'

  - name: Git Commit and Push Action
    uses: mgrybyk-org/git-commit-pull-push-action@v1
    if: always()
    with:
      repository: gh-pages-dir
      branch: gh-pages
      pull_args: --rebase -X ours

Adding PR Comment

Make sure to set id in mgrybyk-org/allure-report-branch-js-action step.

permissions:
  # required by https://github.com/thollander/actions-comment-pull-request
  pull-requests: write

steps:
  # After publishing to gh-pages
  - name: Comment PR with Allure Report link
    if: ${{ always() && github.event_name == 'pull_request' && steps.allure.outputs.report_url }}
    continue-on-error: true
    uses: thollander/actions-comment-pull-request@v2
    with:
      message: |
        ${{ steps.allure.outputs.test_result_icon }} [Allure Report](${{ steps.allure.outputs.report_url }}) | [History](${{ steps.allure.outputs.report_history_url }})
      comment_tag: allure_report
      mode: recreate

Screenshots

Allure Reports History PR Comment Allure Report Trend

API

Please see action.yml

Troubleshooting

Issues on push to gh-pages

Log ! [rejected] HEAD -> gh-pages (non-fast-forward)

Do not run your workflow concurrently per PR or branch!

# Allow only one job per PR or branch
concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.ref }}
  cancel-in-progress: true # true to cancel jobs in progress, set to false otherwise

Running in Windows or MacOS

Make sure you have Java installed in prior to running the action. GitHub runners ubuntu-latest, windows-latest, macos-latest have Java installed so no action is required.

Credits

Planned features

  • cleanup data.json file per report. Raise an issue if you're interested!