{"id":18881138,"url":"https://github.com/godogx/allure","last_synced_at":"2025-10-08T22:44:01.125Z","repository":{"id":39613903,"uuid":"403879071","full_name":"godogx/allure","owner":"godogx","description":"Allure result formatter for godog","archived":false,"fork":false,"pushed_at":"2024-10-29T17:25:21.000Z","size":398,"stargazers_count":4,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-10-29T18:32:13.909Z","etag":null,"topics":["allure-report","bdd","cucumber","go","godog","godog-extension","golang","report","testing"],"latest_commit_sha":null,"homepage":"","language":"Go","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/godogx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-07T07:12:24.000Z","updated_at":"2024-10-29T17:06:00.000Z","dependencies_parsed_at":"2024-06-25T14:33:23.264Z","dependency_job_id":"3a850d92-6000-4ef2-b010-f54ae876f5b5","html_url":"https://github.com/godogx/allure","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":"bool64/go-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godogx%2Fallure","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godogx%2Fallure/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godogx%2Fallure/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/godogx%2Fallure/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/godogx","download_url":"https://codeload.github.com/godogx/allure/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223644821,"owners_count":17178764,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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-report","bdd","cucumber","go","godog","godog-extension","golang","report","testing"],"created_at":"2024-11-08T06:47:39.397Z","updated_at":"2025-10-08T22:43:56.088Z","avatar_url":"https://github.com/godogx.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Allure Formatter\n\n[![Build Status](https://github.com/godogx/allure/workflows/test-unit/badge.svg)](https://github.com/godogx/allure/actions?query=branch%3Amaster+workflow%3Atest-unit)\n[![Coverage Status](https://codecov.io/gh/godogx/allure/branch/master/graph/badge.svg)](https://codecov.io/gh/godogx/allure)\n[![GoDevDoc](https://img.shields.io/badge/dev-doc-00ADD8?logo=go)](https://pkg.go.dev/github.com/godogx/allure)\n[![Time Tracker](https://wakatime.com/badge/github/godogx/allure.svg)](https://wakatime.com/badge/github/godogx/allure)\n![Code lines](https://sloc.xyz/github/godogx/allure/?category=code)\n![Comments](https://sloc.xyz/github/godogx/allure/?category=comments)\n\nStores [`godog`](https://github.com/cucumber/godog) test results in `allure 2` format.\n\n## Usage\n\n[Allure](https://github.com/allure-framework/allure2) is convenient UI to expose test results.\n\nYou can enable it by calling `allure.RegisterFormatter()`.\n\nAdditional configuration can be added with env vars before test run.\n\n`ALLURE_ENV_*` are added to allure environment report.\n\n`ALLURE_EXECUTOR_*` configure `Executor` info.\n\n`ALLURE_RESULTS_PATH` can change default `./allure-results` destination.\n\nExample:\n```bash\nexport ALLURE_ENV_TICKET=JIRA-1234\nexport ALLURE_ENV_APP=todo-list\nexport ALLURE_EXECUTOR_NAME=IntegrationTest\nexport ALLURE_EXECUTOR_TYPE=github\nexport ALLURE_EXECUTOR_URL=https://github.com/\n```\n\nThen you can run test with\n```bash\n# Optionally clean up current result (if you have it).\nrm -rf ./allure-results/*\n# Optionally copy history from previous report.\ncp -r ./allure-report/history ./allure-results/history\n# Run suite with godog CLI tool or with go test.\ngodog -f allure\n# Generate report with allure CLI tool.\nallure generate --clean\n```\n\n[Example instrumentation](https://github.com/vearutop/cache-story/blob/v1.1.0/.github/workflows/test-integration.yml#L139-L162) and [sample report](https://vearutop.github.io/cache-story/).\n\n## Sample report\n\n![Screenshot](_testdata/screenshot.png)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgodogx%2Fallure","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgodogx%2Fallure","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgodogx%2Fallure/lists"}