{"id":16215628,"url":"https://github.com/andrcuns/allure-report-publisher","last_synced_at":"2026-04-18T10:13:02.567Z","repository":{"id":37821752,"uuid":"359908262","full_name":"andrcuns/allure-report-publisher","owner":"andrcuns","description":"Upload allure reports to cloud storage","archived":false,"fork":false,"pushed_at":"2026-04-10T12:24:45.000Z","size":9393,"stargazers_count":41,"open_issues_count":0,"forks_count":12,"subscribers_count":2,"default_branch":"main","last_synced_at":"2026-04-16T22:07:38.382Z","etag":null,"topics":["allure","gcs","s3","test-reporting"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/andrcuns.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null},"funding":{"github":["andrcuns"],"ko_fi":"andrcuns"}},"created_at":"2021-04-20T18:05:30.000Z","updated_at":"2026-04-10T12:24:48.000Z","dependencies_parsed_at":"2026-03-24T23:02:05.162Z","dependency_job_id":null,"html_url":"https://github.com/andrcuns/allure-report-publisher","commit_stats":{"total_commits":508,"total_committers":4,"mean_commits":127.0,"dds":0.4409448818897638,"last_synced_commit":"7502b12bab42f8779005c0fa1023efbda5b6742d"},"previous_names":["andrcuns/allure-report-uploader"],"tags_count":88,"template":false,"template_full_name":null,"purl":"pkg:github/andrcuns/allure-report-publisher","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrcuns%2Fallure-report-publisher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrcuns%2Fallure-report-publisher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrcuns%2Fallure-report-publisher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrcuns%2Fallure-report-publisher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andrcuns","download_url":"https://codeload.github.com/andrcuns/allure-report-publisher/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andrcuns%2Fallure-report-publisher/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31964734,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-18T00:39:45.007Z","status":"online","status_checked_at":"2026-04-18T02:00:07.018Z","response_time":103,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["allure","gcs","s3","test-reporting"],"created_at":"2024-10-10T11:15:35.283Z","updated_at":"2026-04-18T10:13:02.560Z","avatar_url":"https://github.com/andrcuns.png","language":"TypeScript","funding_links":["https://github.com/sponsors/andrcuns","https://ko-fi.com/andrcuns"],"categories":[],"sub_categories":[],"readme":"# allure-report-publisher\n\n[![Docker Image Version (latest semver)](https://img.shields.io/docker/v/andrcuns/allure-report-publisher?color=blue\u0026label=docker\u0026sort=semver)](https://hub.docker.com/r/andrcuns/allure-report-publisher)\n[![Docker Pulls](https://img.shields.io/docker/pulls/andrcuns/allure-report-publisher)](https://hub.docker.com/r/andrcuns/allure-report-publisher)\n[![codecov](https://codecov.io/gh/andrcuns/allure-report-publisher/graph/badge.svg?token=YT3U8GYHHP)](https://codecov.io/gh/andrcuns/allure-report-publisher)\n![Workflow status](https://github.com/andrcuns/allure-report-publisher/workflows/Test/badge.svg)\n\nUpload your report to a file storage of your choice.\n\n![Demo](demo.gif)\n\n# Usage\n\n\u003c!-- usage --\u003e\n```sh-session\n$ npm install -g allure-report-publisher\n$ allure-report-publisher COMMAND\nrunning command...\n$ allure-report-publisher (--version)\nallure-report-publisher/5.4.0 linux-x64 node-v25.9.0\n$ allure-report-publisher --help [COMMAND]\nUSAGE\n  $ allure-report-publisher COMMAND\n...\n```\n\u003c!-- usagestop --\u003e\n\u003c!-- commands --\u003e\n* [`allure-report-publisher upload gcs`](#allure-report-publisher-upload-gcs)\n* [`allure-report-publisher upload gitlab-artifacts`](#allure-report-publisher-upload-gitlab-artifacts)\n* [`allure-report-publisher upload s3`](#allure-report-publisher-upload-s3)\n\n## `allure-report-publisher upload gcs`\n\nGenerate and upload allure report to gcs bucket\n\n```\nUSAGE\n  $ allure-report-publisher upload gcs -b \u003cvalue\u003e [-r \u003cvalue\u003e] [-c \u003cvalue\u003e] [--report-name \u003cvalue\u003e] [-o \u003cvalue\u003e]\n    [--global-allure-exec] [--ci-report-title \u003cvalue\u003e] [--update-pr comment|description|actions] [--add-summary]\n    [--collapse-summary] [--flaky-warning-status] [--color] [--debug] [--ignore-missing-results] [-p \u003cvalue\u003e]\n    [--base-url \u003cvalue\u003e] [--copy-latest] [--parallel \u003cvalue\u003e]\n\nFLAGS\n  -b, --bucket=\u003cvalue\u003e           (required) [env: ALLURE_BUCKET] Cloud storage bucket name\n  -c, --config=\u003cvalue\u003e           [env: ALLURE_CONFIG] The path to allure config file. Options provided here will\n                                 override CLI flags\n  -o, --output=\u003cvalue\u003e           [env: ALLURE_OUTPUT] Directory to generate the Allure report into\n  -p, --prefix=\u003cvalue\u003e           [env: ALLURE_PREFIX] Prefix for report path in cloud storage\n  -r, --results-glob=\u003cvalue\u003e     [default: ./**/allure-results, env: ALLURE_RESULTS_GLOB] Glob pattern for allure\n                                 results directories\n      --add-summary              [env: ALLURE_SUMMARY] Add test summary table to section in PR\n      --base-url=\u003cvalue\u003e         [env: ALLURE_BASE_URL] Custom base URL for report links\n      --ci-report-title=\u003cvalue\u003e  [default: Allure Report, env: ALLURE_CI_REPORT_TITLE] Title for PR comment/description\n                                 section\n      --collapse-summary         [env: ALLURE_COLLAPSE_SUMMARY] Create collapsible summary section in PR\n      --[no-]color               [env: ALLURE_COLOR] Force color output\n      --copy-latest              [env: ALLURE_COPY_LATEST] Keep copy of latest run report at base prefix\n      --debug                    [env: ALLURE_DEBUG] Print debug log output\n      --flaky-warning-status     [env: ALLURE_FLAKY_WARNING_STATUS] Mark run with ! status if flaky tests found\n      --global-allure-exec       [env: ALLURE_GLOBAL_ALLURE_EXEC] Use globally installed allure executable instead of\n                                 the packaged one\n      --ignore-missing-results   [env: ALLURE_IGNORE_MISSING_RESULTS] Ignore missing allure results and exit without\n                                 error if no result paths found\n      --parallel=\u003cvalue\u003e         [default: 8, env: ALLURE_PARALLEL] Number of parallel threads for upload\n      --report-name=\u003cvalue\u003e      [env: ALLURE_REPORT_NAME] Custom report name in Allure report\n      --update-pr=\u003coption\u003e       [env: ALLURE_UPDATE_PR] Update PR with a section containing the report URL\n                                 \u003coptions: comment|description|actions\u003e\n\nDESCRIPTION\n  Generate and upload allure report to gcs bucket\n\nEXAMPLES\n  $ allure-report-publisher upload gcs --results-glob=\"path/to/allure-results\" --bucket=my-bucket\n\n  $ allure-report-publisher upload gcs --results-glob=\"path/to/allure-results\" --bucket=my-bucket --update-pr=comment --summary=behaviors\n```\n\n_See code: [src/commands/upload/gcs.ts](https://github.com/andrcuns/allure-report-publisher/blob/v5.4.0/src/commands/upload/gcs.ts)_\n\n## `allure-report-publisher upload gitlab-artifacts`\n\nGenerate report and output GitLab CI artifacts links\n\n```\nUSAGE\n  $ allure-report-publisher upload gitlab-artifacts [-r \u003cvalue\u003e] [-c \u003cvalue\u003e] [--report-name \u003cvalue\u003e] [-o \u003cvalue\u003e]\n    [--global-allure-exec] [--ci-report-title \u003cvalue\u003e] [--update-pr comment|description|actions] [--add-summary]\n    [--collapse-summary] [--flaky-warning-status] [--color] [--debug] [--ignore-missing-results]\n\nFLAGS\n  -c, --config=\u003cvalue\u003e           [env: ALLURE_CONFIG] The path to allure config file. Options provided here will\n                                 override CLI flags\n  -o, --output=\u003cvalue\u003e           [env: ALLURE_OUTPUT] Directory to generate the Allure report into\n  -r, --results-glob=\u003cvalue\u003e     [default: ./**/allure-results, env: ALLURE_RESULTS_GLOB] Glob pattern for allure\n                                 results directories\n      --add-summary              [env: ALLURE_SUMMARY] Add test summary table to section in PR\n      --ci-report-title=\u003cvalue\u003e  [default: Allure Report, env: ALLURE_CI_REPORT_TITLE] Title for PR comment/description\n                                 section\n      --collapse-summary         [env: ALLURE_COLLAPSE_SUMMARY] Create collapsible summary section in PR\n      --[no-]color               [env: ALLURE_COLOR] Force color output\n      --debug                    [env: ALLURE_DEBUG] Print debug log output\n      --flaky-warning-status     [env: ALLURE_FLAKY_WARNING_STATUS] Mark run with ! status if flaky tests found\n      --global-allure-exec       [env: ALLURE_GLOBAL_ALLURE_EXEC] Use globally installed allure executable instead of\n                                 the packaged one\n      --ignore-missing-results   [env: ALLURE_IGNORE_MISSING_RESULTS] Ignore missing allure results and exit without\n                                 error if no result paths found\n      --report-name=\u003cvalue\u003e      [env: ALLURE_REPORT_NAME] Custom report name in Allure report\n      --update-pr=\u003coption\u003e       [env: ALLURE_UPDATE_PR] Update PR with a section containing the report URL\n                                 \u003coptions: comment|description|actions\u003e\n\nDESCRIPTION\n  Generate report and output GitLab CI artifacts links\n```\n\n_See code: [src/commands/upload/gitlab-artifacts.ts](https://github.com/andrcuns/allure-report-publisher/blob/v5.4.0/src/commands/upload/gitlab-artifacts.ts)_\n\n## `allure-report-publisher upload s3`\n\nGenerate and upload allure report to s3 bucket\n\n```\nUSAGE\n  $ allure-report-publisher upload s3 -b \u003cvalue\u003e [-r \u003cvalue\u003e] [-c \u003cvalue\u003e] [--report-name \u003cvalue\u003e] [-o \u003cvalue\u003e]\n    [--global-allure-exec] [--ci-report-title \u003cvalue\u003e] [--update-pr comment|description|actions] [--add-summary]\n    [--collapse-summary] [--flaky-warning-status] [--color] [--debug] [--ignore-missing-results] [-p \u003cvalue\u003e]\n    [--base-url \u003cvalue\u003e] [--copy-latest] [--parallel \u003cvalue\u003e]\n\nFLAGS\n  -b, --bucket=\u003cvalue\u003e           (required) [env: ALLURE_BUCKET] Cloud storage bucket name\n  -c, --config=\u003cvalue\u003e           [env: ALLURE_CONFIG] The path to allure config file. Options provided here will\n                                 override CLI flags\n  -o, --output=\u003cvalue\u003e           [env: ALLURE_OUTPUT] Directory to generate the Allure report into\n  -p, --prefix=\u003cvalue\u003e           [env: ALLURE_PREFIX] Prefix for report path in cloud storage\n  -r, --results-glob=\u003cvalue\u003e     [default: ./**/allure-results, env: ALLURE_RESULTS_GLOB] Glob pattern for allure\n                                 results directories\n      --add-summary              [env: ALLURE_SUMMARY] Add test summary table to section in PR\n      --base-url=\u003cvalue\u003e         [env: ALLURE_BASE_URL] Custom base URL for report links\n      --ci-report-title=\u003cvalue\u003e  [default: Allure Report, env: ALLURE_CI_REPORT_TITLE] Title for PR comment/description\n                                 section\n      --collapse-summary         [env: ALLURE_COLLAPSE_SUMMARY] Create collapsible summary section in PR\n      --[no-]color               [env: ALLURE_COLOR] Force color output\n      --copy-latest              [env: ALLURE_COPY_LATEST] Keep copy of latest run report at base prefix\n      --debug                    [env: ALLURE_DEBUG] Print debug log output\n      --flaky-warning-status     [env: ALLURE_FLAKY_WARNING_STATUS] Mark run with ! status if flaky tests found\n      --global-allure-exec       [env: ALLURE_GLOBAL_ALLURE_EXEC] Use globally installed allure executable instead of\n                                 the packaged one\n      --ignore-missing-results   [env: ALLURE_IGNORE_MISSING_RESULTS] Ignore missing allure results and exit without\n                                 error if no result paths found\n      --parallel=\u003cvalue\u003e         [default: 8, env: ALLURE_PARALLEL] Number of parallel threads for upload\n      --report-name=\u003cvalue\u003e      [env: ALLURE_REPORT_NAME] Custom report name in Allure report\n      --update-pr=\u003coption\u003e       [env: ALLURE_UPDATE_PR] Update PR with a section containing the report URL\n                                 \u003coptions: comment|description|actions\u003e\n\nDESCRIPTION\n  Generate and upload allure report to s3 bucket\n\nEXAMPLES\n  $ allure-report-publisher upload s3 --results-glob=\"path/to/allure-results\" --bucket=my-bucket\n\n  $ allure-report-publisher upload s3 --results-glob=\"path/to/allure-results\" --bucket=my-bucket --update-pr=comment --summary=behaviors\n```\n\n_See code: [src/commands/upload/s3.ts](https://github.com/andrcuns/allure-report-publisher/blob/v5.4.0/src/commands/upload/s3.ts)_\n\u003c!-- commandsstop --\u003e\n\n## Docker\n\nDockerized version of cli can be used by passing same arguments to `andrcuns/allure-report-publisher` image:\n\n```sh-session\ndocker run --rm -it \\\n  -v ${PWD}:/app/data \\\n  -e AWS_ACCESS_KEY_ID=${AWS_ACCESS_KEY_ID} \\\n  -e AWS_SECRET_ACCESS_KEY=${AWS_SECRET_ACCESS_KEY} \\\n  andrcuns/allure-report-publisher:latest upload s3 --results-glob=\"/app/data/**/allure-results\" --bucket=my-bucket\n```\n\n## Allure configuration file\n\nIt is possible to provide [Allure configuration file](https://allurereport.org/docs/v3/configure/) via `--config` flag. Dynamic javascript files are supported, but plain javascript object without the use of `defineConfig` is suggested due to `defineConfig` helper loading `allure` cli parser which will create error output.\n\n# Storage providers\n\nMultiple cloud storage providers are supported\n\n## AWS S3\n\nRequires environment variables `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` or credentials file `~/.aws/credentials`\n\nAdditional configuration:\n\n* `AWS_REGION`: configure s3 region, default: `us-east-1`\n* `AWS_FORCE_PATH_STYLE`: when set to true, the bucket name is always left in the request URI and never moved to the host as a sub-domain, default: `false`\n* `AWS_ENDPOINT`: custom s3 endpoint when used with other s3 compatible storage\n\n## Google Cloud Storage\n\nGCS node.js client uses [ADC](https://docs.cloud.google.com/docs/authentication/application-default-credentials) to detect credentials. Easiest way is to set `GOOGLE_APPLICATION_CREDENTIALS` environment variable pointing to service account credentials.json file.\n\n## Gitlab Artifacts\n\nThis storage provider is only supported for GitLab CI. Because GitLab does not expose public api for uploading artifacts, a job must be configured to upload the report as an artifact. Example:\n\n```yaml\n# .gitlab-ci.yml\nartifacts:\n  paths:\n    - allure-report\n```\n\nwhere `allure-report` is the directory containing the generated Allure report and can be overridden via `--output` option.\n\nRequires environment variable `GITLAB_AUTH_TOKEN` where token is a GitLab personal access token with `api` scope capable of downloading artifacts and retrieving job and pipeline information.\n\nThis provider is meant to be used with [GitLab CI](#gitlab-ci).\n\n# CI\n\n`allure-report-publisher` will automatically detect if used in CI environment and add relevant executor info and history.\n\nFollowing CI providers are supported:\n\n* Github Actions\n* Gitlab CI\n\n## Pull requests\n\nIt is possible to update pull requests with urls to published reports and execution summary.\n\n* `--update-pr=(comment|description|actions)`: post report urls in pr description, as a comment or step summary for github actions\n\nExample:\n\n---\n\n`# Allure report`\n\n`allure-report-publisher` generated test report!\n\n**test**: ✅ [test report](https://storage.googleapis.com/allure-test-reports/allure-report-publisher/refs/heads/main/index.html) for [1b756f48](https://github.com/andrcuns/allure-report-publisher/commit/HEAD)\n\n```console\n  +----------+----------+----------+----------+----------+----------+\n  |  passed  |  failed  |  flaky   | retried  | skipped  |  total   |\n  +----------+----------+----------+----------+----------+----------+\n  |    69    |    0     |    0     |    0     |    0     |    69    |\n  +----------+----------+----------+----------+----------+----------+\n```\n\n---\n\n## Github Actions\n\nAdditional configuration is done via environment variables\n\nAuthentication for PR updates:\n\n* `GITHUB_AUTH_TOKEN`: github auth token with api access\n\nFollowing environment variables can override default CI values:\n\n* `ALLURE_JOB_NAME`: overrides default `GITHUB_JOB` value which is used as name for report url section\n* `ALLURE_RUN_ID`: overrides default `GITHUB_RUN_ID` value which is used as name for the run number\n\n### allure-publish-action\n\n[allure-publish-action](https://github.com/marketplace/actions/allure-publish-action) can be used to easily run report publishing from any github actions job.\n\n## Gitlab CI\n\nAdditional configuration is done via environment variables\n\n### Authentication\n\nAuthentication for MR updates:\n\n* `GITLAB_AUTH_TOKEN`: gitlab access token with api access\n\n### CI values\n\nFollowing environment variables can override default CI values:\n\n* `ALLURE_JOB_NAME`: overrides default `CI_JOB_NAME` value which is used as name for report url section\n* `ALLURE_RUN_ID`: overrides default `CI_PIPELINE_ID` value which is used as name for the run number\n\nIn case merge request triggers a downstream pipeline yet you want to update original merge request, overriding following environment variables might be useful:\n\n* `ALLURE_PROJECT_PATH`: overrides default `CI_PROJECT_PATH` value\n* `ALLURE_MERGE_REQUEST_IID`: overrides default `CI_MERGE_REQUEST_IID` value\n* `ALLURE_COMMIT_SHA`: overrides default `CI_MERGE_REQUEST_SOURCE_BRANCH_SHA` or `CI_COMMIT_SHA` values\n\n### CI/CD catalog resource\n\n[allure-report-publisher CI/CD catalog resource](https://gitlab.com/andrcuns/allure-report-publisher) can be used to easily integrate report publishing in to Gitlab CI pipelines.\n\n# Development\n\nLocal development tool are handled by [mise](https://mise.jdx.dev/). After checking out the repo, run `mise install` to install necessary dev tools. Run `pnpm install` to install all node dependencies. To run tests, use `pnpm run test`. `bin/dev.js` allows to execute the cli directly from the source code without building it first.\n\n# Contributing\n\nBug reports and pull requests are welcome on GitHub at \u003chttps://github.com/andrcuns/allure-report-publisher\u003e. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/andrcuns/allure-report-publisher/blob/main/CODE_OF_CONDUCT.md).\n\n# License\n\nThe gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).\n\n# Code of Conduct\n\nEveryone interacting in the allure-report-publisher project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/andrcuns/allure-report-publisher/blob/main/CODE_OF_CONDUCT.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrcuns%2Fallure-report-publisher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandrcuns%2Fallure-report-publisher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandrcuns%2Fallure-report-publisher/lists"}