allure-report-branch-action

A Docker version of the Allure Report with history per branch (type: docker)

JavaScript version of the action: allure-report-with-history-per-branch-js. The JavaScript vesrion is recommended!

See examples:

• Allure History List
• Allure Report
• Browse different branches
• Pull Request Comment Example

Compatible with HTML Trend Report Action.

Usage

1. Enable Pages in your repository settings.

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-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-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

Examples Repos

• https://github.com/mgrybyk/webdriverio-devtools

Screenshots

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

The allure-report-branch-action is designed as a JavaScript action wrapped with docker action because allure requires java and is shipped with bunch of java files.

As far as docker action runs in linux environments only, it's required to do some extra steps for users running Windows and MacOS workflows. See Types of actions for more details.

• option 1: use JS version of this action mgrybyk-org/allure-report-branch-js-action.
• option 2: using upload/download artifacts. See simple-elf/allure-report-action/issues/28#issuecomment-1139332329

Credits

• docker-java-node for building Dockerimage with Java and NodeJS together
• thollander/actions-comment-pull-request for building Github Action that comments the linked PRs

Planned features

• cleanup data.json file per report. Raise an issue if you're interested!
• think how to deal with branch cleaup without using url. Feel free to pick up.