{"id":14969344,"url":"https://github.com/allure-framework/allure-ruby","last_synced_at":"2025-05-15T16:08:13.129Z","repository":{"id":35103590,"uuid":"187669270","full_name":"allure-framework/allure-ruby","owner":"allure-framework","description":"Allure integrations for Ruby test frameworks","archived":false,"fork":false,"pushed_at":"2025-05-06T07:28:27.000Z","size":874,"stargazers_count":59,"open_issues_count":1,"forks_count":23,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-05-08T05:29:00.528Z","etag":null,"topics":["allure","cucumber","reporting","reporting-engine","rspec"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/allure-framework.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","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},"funding":{"github":["andrcuns"],"ko_fi":"andrcuns"}},"created_at":"2019-05-20T15:38:45.000Z","updated_at":"2025-05-06T07:28:30.000Z","dependencies_parsed_at":"2023-02-10T11:16:03.864Z","dependency_job_id":"95a973f2-afea-4d20-8d1c-696a0174e94f","html_url":"https://github.com/allure-framework/allure-ruby","commit_stats":{"total_commits":564,"total_committers":17,"mean_commits":33.1764705882353,"dds":0.5053191489361701,"last_synced_commit":"aa04a88dcbf62d4aefb3710d835f55dea14f3f34"},"previous_names":[],"tags_count":49,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allure-framework%2Fallure-ruby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allure-framework%2Fallure-ruby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allure-framework%2Fallure-ruby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allure-framework%2Fallure-ruby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/allure-framework","download_url":"https://codeload.github.com/allure-framework/allure-ruby/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254374475,"owners_count":22060611,"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","cucumber","reporting","reporting-engine","rspec"],"created_at":"2024-09-24T13:41:43.508Z","updated_at":"2025-05-15T16:08:13.080Z","avatar_url":"https://github.com/allure-framework.png","language":"Ruby","readme":"# Allure ruby\n\n[![Gem Version](https://badge.fury.io/rb/allure-ruby-commons.svg)](https://rubygems.org/gems/allure-ruby-commons)\n[![Total Downloads](https://img.shields.io/gem/dt/allure-ruby-commons?color=blue)](https://rubygems.org/gems/allure-ruby-commons)\n![Workflow status](https://github.com/allure-framework/allure-ruby/workflows/Test/badge.svg)\n[![Maintainability](https://api.codeclimate.com/v1/badges/3190a4c9e68f20dd82ec/maintainability)](https://codeclimate.com/github/allure-framework/allure-ruby/maintainability)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/3190a4c9e68f20dd82ec/test_coverage)](https://codeclimate.com/github/allure-framework/allure-ruby/test_coverage)\n[![Yard Docs](https://img.shields.io/badge/yard-docs-blue.svg)](https://rubydoc.info/github/allure-framework/allure-ruby/master)\n[![Test Report](https://img.shields.io/badge/report-allure-blue.svg)](https://storage.googleapis.com/allure-test-reports/allure-ruby/refs/heads/master/index.html)\n\nRuby testing framework adaptors for generating allure compatible test reports.\n\n## Supported frameworks\n\n### allure-cucumber\n\n[![Gem Version](https://badge.fury.io/rb/allure-cucumber.svg)](https://rubygems.org/gems/allure-cucumber)\n[![Downloads](https://img.shields.io/gem/dt/allure-cucumber?color=blue)](https://rubygems.org/gems/allure-cucumber)\n\n```ruby\ngem \"allure-cucumber\"\n```\n\nImplementation of allure adaptor for [Cucumber](https://github.com/cucumber/cucumber-ruby) testing framework\n\nDetailed usage and setup instruction can be found in [allure-cucumber docs](allure-cucumber/README.md)\n\n### allure-rspec\n\n[![Gem Version](https://badge.fury.io/rb/allure-rspec.svg)](https://rubygems.org/gems/allure-rspec)\n[![Downloads](https://img.shields.io/gem/dt/allure-rspec?color=blue)](https://rubygems.org/gems/allure-rspec)\n\n```ruby\ngem \"allure-rspec\"\n```\n\nImplementation of allure adaptor for [RSpec](https://github.com/rspec/rspec) testing framework\n\nDetailed usage and setup instruction can be found in [allure-rspec docs](allure-rspec/README.md)\n\n## Development\n\n### allure-ruby-commons\n\n[![Gem Version](https://badge.fury.io/rb/allure-ruby-commons.svg)](https://rubygems.org/gems/allure-ruby-commons)\n\n```ruby\ngem \"allure-ruby-commons\"\n```\n\nCommon allure lifecycle interface to be used by other testing frameworks to generate allure reports\n\nInteraction and usage of allure lifecycle is described in [allure-ruby-commons docs](allure-ruby-commons/README.md)\n\n### Contributing\n\n- Install dependencies:\n\n```console\n$ bundle install\nBundle complete! ...\n```\n\n- Make changes\n\n- Run linter:\n\n```console\n$ bundle exec rake rubocop\nExecuting rubocop for allure-cucumber\n...\nno offenses detected\n\nExecuting rubocop for allure-rspec\n...\nno offenses detected\n\nExecuting rubocop for allure-ruby-commons\n...\nno offenses detected\n```\n\n- Run tests:\n\n```console\n$ bundle exec rake test\nExecuting test for allure-cucumber\n...\n0 failures\n\nExecuting test for allure-rspec\n...\n0 failures\n\nExecuting test for allure-ruby-commons\n...\n0 failures\n```\n\n- Submit a PR\n\n### Releasing\n\nNew version can be created by triggering manual `Release` workflow\n\n## Generating HTML report\n\nRuby binding hosted in this repository only generate source json files for the [allure2](https://github.com/allure-framework/allure2) reporter.\n\nSee [documentation](https://allurereport.org/) on how to use allure report.\n\n### Using with CI providers\n\n[allure-report-publisher](https://github.com/andrcuns/allure-report-publisher) provides a docker image which can be run from github-actions\nworkflow or gitlab-ci pipeline and host reports using cloud providers like AWS or GCP.\n","funding_links":["https://github.com/sponsors/andrcuns","https://ko-fi.com/andrcuns"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallure-framework%2Fallure-ruby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fallure-framework%2Fallure-ruby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallure-framework%2Fallure-ruby/lists"}