{"id":25776326,"url":"https://github.com/Decathlon/ara","last_synced_at":"2025-02-27T06:06:04.358Z","repository":{"id":37445153,"uuid":"179502880","full_name":"Decathlon/ara","owner":"Decathlon","description":"Agile Regression Analyzer","archived":false,"fork":false,"pushed_at":"2025-02-14T11:04:23.000Z","size":24649,"stargazers_count":78,"open_issues_count":174,"forks_count":19,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-02-20T08:09:07.758Z","etag":null,"topics":["cucumber","hacktoberfest","regression","test"],"latest_commit_sha":null,"homepage":"","language":"Java","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/Decathlon.png","metadata":{"files":{"readme":"README.adoc","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":"2019-04-04T13:27:58.000Z","updated_at":"2025-02-11T10:29:16.000Z","dependencies_parsed_at":"2024-01-08T09:30:34.596Z","dependency_job_id":"f5ec18da-1359-4d30-ab5f-d0b5cedfe94f","html_url":"https://github.com/Decathlon/ara","commit_stats":null,"previous_names":[],"tags_count":171,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Decathlon%2Fara","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Decathlon%2Fara/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Decathlon%2Fara/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Decathlon%2Fara/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Decathlon","download_url":"https://codeload.github.com/Decathlon/ara/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240514156,"owners_count":19813682,"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":["cucumber","hacktoberfest","regression","test"],"created_at":"2025-02-27T06:01:21.551Z","updated_at":"2025-02-27T06:06:04.350Z","avatar_url":"https://github.com/Decathlon.png","language":"Java","funding_links":[],"categories":["测试"],"sub_categories":[],"readme":"= image:code/web-ui/src/assets/favicon.png[Logo,64,64] ARA - Agile Regression Analyzer\n\nimage:https://github.com/Decathlon/ara/actions/workflows/build.yaml/badge.svg?branch=main\u0026event=push[BUILD] image:https://github.com/Decathlon/ara/actions/workflows/charts-release.yaml/badge.svg?branch=main\u0026event=push[CHARTS]\n\nimage:https://img.shields.io/badge/commitizen-friendly-brightgreen.svg[link=\"http://commitizen.github.io/cz-cli/\"] image:https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release[link=\"https://github.com/semantic-release/semantic-release\"]\n\nARA icon by https://github.com/slaout[Sébastien Laout], licensed under https://creativecommons.org/licenses/by-nc-sa/4.0/[Creative Commons 4.0 Attributions license]\n[#img-by-nc-sa]\n[caption=\"Creative commons by-nc-sa logo: \",link=https://creativecommons.org/licenses/by-nc-sa/4.0/]\nimage::https://mirrors.creativecommons.org/presskit/buttons/88x31/png/by-nc-sa.png[Creative commons by-nc-sa logo,83,31]\n\n== What is ARA?\n\nARA helps you to fight against regressions by letting it preanalyze your non-regression tests runs,\ntracks and follows problems, keep their history, and even break your CI build if quality isn't\nmet.\n\n== How to locally install it\n\nIf you just want to install it locally to give it a try, you can !\nAlso, after this installation, you can follow up the \u003c\u003cdoc/usage/demo/DemoWalkthrough.adoc#head, Demo walkthrough\u003e\u003e\nto explore ARA features !!\n\nPlease note the following :\n\n* You'll need https://docs.docker.com/install/[Docker]\n* All the datas that you import in ARA won't be persisted.\n* The port 7000, 9000, 5432 must be available locally.\n* Add to `/etc/hosts` (Linux OS) or to `/private/etc/hosts` (MacOS) or to `c:\\Windows\\System32\\drivers\\etc\\` (Windows) `127.0.0.1 oauth2.dev.localhost`\n\n=== I've got a Windows PC !\n\n1. Open a Powershell Command Prompt\n2. Run the command `Invoke-WebRequest -OutFile docker compose.yml https://raw.githubusercontent.com/Decathlon/ara/main/code/docker-compose.yaml`\n3. Run the command `docker compose up`\n4. Open up a browser on `http://127.0.0.1:7000`\n5. Enjoy ! You can sign in with `admin`/`admin`\n6. To stop it, in the command line, just do a `docker compose down` in the same directory as the `docker-compose.yaml`\n7. To restart it, in the command line do a `docker compose up` in the same directory as the `docker-compose.yaml`\n\n\n=== I've got a Mac !\n\n1. Open a Terminal\n2. Run the command `wget https://raw.githubusercontent.com/Decathlon/ara/main/code/docker-compose.yaml`\n3. Run the command `docker compose up`\n4. Open up a browser on `http://127.0.0.1:7000`\n5. Enjoy ! You can sign in with `admin`/`admin`\n6. To stop it, in the command line, just do a `docker compose down` in the same directory as the `docker-compose.yaml`\n7. To restart it, in the command line do a `docker compose up` in the same directory as the `docker-compose.yaml`\n\n\n=== I've got a GNU/Linux PC !\n\n1. Open a Terminal\n2. Run the command `wget https://raw.githubusercontent.com/Decathlon/ara/main/code/docker-compose.yaml`\n3. Run the command `docker compose up`\n4. Open up a browser on `http://127.0.0.1:7000`\n5. Enjoy ! You can sign in with `admin`/`admin`\n6. To stop it, in the command line, just do a `docker compose down` in the same directory as the `docker-compose.yaml`\n7. To restart it, in the command line do a `docker compose up` in the same directory as the `docker-compose.yaml`\n\n== How to install it on my Infrastructure\n\nARA has a Helm chart to easily install it in a Kubernetes Cluster.\n\n* Add the ara repository if not already added:\n\n```shell\nhelm repo add ara https://decathlon.github.io/ara/\n```\n\n* Update repositories\n\n```shell\nhelm repo update\n```\n\n* Install it with custom values\n\n```shell\nhelm install -f values.yaml --create-namespace --namespace ara my-ara ara/ara-stable\n```\n\nA sample `values.yaml` could be like this one:\n\n```yaml\napi:\n  authentication: oauth2-github # Put a friendly value to disable default authentication\n  customConfig:\n    # Active providers\n    # provider-type has to be one of custom / github / google\n    # code refers to the provider key ( spring.security.oauth2.client.registration.\u003ccode\u003e)\n    oauth2providers:\n      conf:\n      - display-name: Github\n        provider-type: github\n        code: github\n\n    # Oauth\n    spring:\n      security:\n        oauth2:\n          client:\n            registration:\n              github:\n                clientId: YOUR_OAUTH2_CLIENT_ID\n                clientSecret: YOUR_OAUTH2_CLIENT_SECRET\n                redirect-uri: \"${ara.clientBaseUrl}/${ara.loginProcessingUrl}/{registrationId}\"\n\n```\n\nYou can use any other OAuth2 provider supported by Spring Security (e.g. Facebook, Google, custom, etc.).\n\nTo install and ARA version on the candidate channel:\n```shell\nhelm install -f values.yaml --create-namespace --namespace ara my-ara ara/ara-candidate\n```\n\n\n== How to Use ARA?\n\nYou can go through the \u003c\u003cdoc/usage/demo/DemoWalkthrough.adoc#head, Demo Walkthrough\u003e\u003e to quickly learn how to\nuse ARA.\n\nYou can also read the \u003c\u003cdoc/usage/main/UserDocumentation.adoc#head, User Documentation\u003e\u003e to learn everything\nyou need to know about the utilization of ARA (don't hesitate to pass those doc to the rest of your teams ;) ).\n\n== How to Develop on ARA?\n\nPlease read the \u003c\u003cdoc/development/install/DeveloperDocumentation.adoc#head, Developer Documentation\u003e\u003e\nto learn how the project is structured and how to develop new features in ARA and/or contribute.\nTo start a development environment:\n----\n\u003e cd code\n\u003e docker compose -f code/docker-compose.dev.yml up -d\n\u003e docker compose -f code/docker-compose.dev.yml logs -f --tail 200\n----\n\n=== Commit convention\n\nARA use https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-format[Angular Commit Message Conventions] in order to generate nice changelog and increase maintenability and lisibility.\n\nIn local environment, you can use git hooks configured for developer.\n\nTo enable this tools, `node` is required. You can follow this step to use it:\n\n```\nnpm install\n```\n\nThen `git commit` command will trigger a prompt to build a proper commit message.\n\nAnd that's all !\n\nYou can now use the standard `git commit` to interact with a prompt to build your conventional commits.\n\nIn order to disable the commitizen hook if needed, you can fill a specific environment variable:\n\n```\nexport COMMITIZEN_HOOK_DISABLED=true\n```\n\nWith this, commitizen promp will be skiped.\n\n[NOTE]\n.Tools used\n====\n* https://github.com/commitizen/cz-cli[commitizen]\n* https://github.com/typicode/husky[husky]\n====\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDecathlon%2Fara","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FDecathlon%2Fara","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FDecathlon%2Fara/lists"}