{"id":19041862,"url":"https://github.com/allure-framework/setup-allurectl","last_synced_at":"2025-04-23T22:21:20.077Z","repository":{"id":36986816,"uuid":"491204439","full_name":"allure-framework/setup-allurectl","owner":"allure-framework","description":"Set up your GitHub Actions workflow with a specific version of allurectl","archived":false,"fork":false,"pushed_at":"2024-05-28T08:44:13.000Z","size":701,"stargazers_count":13,"open_issues_count":10,"forks_count":3,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-30T00:55:04.992Z","etag":null,"topics":["allure","allure-testops","allurectl","github-actions"],"latest_commit_sha":null,"homepage":"https://qameta.io","language":"TypeScript","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":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":"2022-05-11T17:11:06.000Z","updated_at":"2024-09-27T15:43:08.000Z","dependencies_parsed_at":"2024-05-17T07:28:59.559Z","dependency_job_id":"f23fb520-5b42-4dfe-92ec-4e4c01d0fffc","html_url":"https://github.com/allure-framework/setup-allurectl","commit_stats":{"total_commits":7,"total_committers":4,"mean_commits":1.75,"dds":0.4285714285714286,"last_synced_commit":"0181c1c9cf16ec1bab18835d9795311f65dc65f6"},"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allure-framework%2Fsetup-allurectl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allure-framework%2Fsetup-allurectl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allure-framework%2Fsetup-allurectl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/allure-framework%2Fsetup-allurectl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/allure-framework","download_url":"https://codeload.github.com/allure-framework/setup-allurectl/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223294795,"owners_count":17121650,"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","allure-testops","allurectl","github-actions"],"created_at":"2024-11-08T22:32:55.505Z","updated_at":"2024-11-08T22:32:56.083Z","avatar_url":"https://github.com/allure-framework.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# setup-allurectl\n\nThis action intended to help you with the setup of `allurectl` in your workflow.\n\n## What is allurectl\n\n`allurectl` is a CLI wrapper of [Allure Testops](https://qameta.io) API performing the operations for upload of the test results, launches and projects management on Allure Testops side.\n\n## Prerequisites\n\n1. You need to have Allure Testops instance with [trial](https://qameta.io/free-trial) or commercial licence up and running.\n2. You need to create API token which will be used for the authentication. To create tokens, [proceed to your Allure Testops profile.](https://docs.qameta.io/allure-testops/integrations/com/allure-token/)\n3. You need to have a project created in Allure Testops to which you are going to upload the test results.\n\n## Usage\n\nTo upload the test results to Allure Testops please use following instructions in your workflow.\n\n### Use the action into your workflow and setup the action\n\n```yaml\n      - uses: allure-framework/setup-allurectl@v1\n        with: \n          allure-endpoint: https://allure.testops.url\n          allure-token: ${{ secrets.ALLURE_TOKEN }}\n          allure-project-id: \u003cPROJECT_ID\u003e\n```\n\n1. `allure.testops.url` is the URL of your Allure Testops instance without additional context paths, e.g. `https://allure.testops.url`\n2. `${{ secret.ALLURE_TOKEN }}` is the personal API token created in your profile of Allure Testops. You need to save [API Token](https://docs.qameta.io/allure-testops/integrations/com/allure-token/) under `/settings/secrets/actions` as a new secret with name `ALLURE_TOKEN` in your GitHub repository and use it as the reference to the created secret – `${{ secret.ALLURE_TOKEN }}`. Having this parameter saved as plain text in the workflow is a bad idea that will compromise API token and could lead to the data loss. Please avoid this.\n3. \u003cPROJECT_ID\u003e is the ID of a project to which you are sending the test results.\n\n### Use allurectl to upload the test results to Allure Testops\n\n```yaml\n      - run: allurectl watch -- \u003ctest execution command\u003e\n        env: \n          ALLURE_RESULTS: \u003cpath/to/test-results\u003e\n```\n\nwhere\n\n1. `\u003ctest execution command\u003e` is the command for triggering the tests execution, e.g. `./gradlew clean test`\n2. `\u003cpath/to/test-results\u003e` is the path to the directory with test results files, e.g. `build/allure-results`\n\n### Complete example\n\n```yaml\n  on: [push]\n\n  jobs:\n    tests:\n      runs-on: ubuntu-latest\n      steps:\n      - uses: actions/checkout@v3\n      - uses: actions/setup-java@v3\n        with:\n          distribution: 'zulu'\n          java-version: '17'\n          cache: 'gradle'\n      - uses: allure-framework/setup-allurectl@v1\n        with: \n          allure-endpoint: https://demo.Testops.cloud\n          allure-token: ${{ secret.ALLURE_TOKEN }}\n          allure-project-id: 1\n      - run: allurectl watch -- ./gradlew clean test\n        env: \n          ALLURE_RESULTS: build/allure-results\n  ```\n\n### Managing the version of allurectl\n\nIf there a need to use a specific version of allurectl (e.g. if you need to test a pre-release version), you can use additional configuration parameter `allurectl-version`.\n\n```yaml\n      - uses: allure-framework/setup-allurectl@v1\n        with: \n          allure-endpoint: https://ALURE_Testops_URL\n          allure-token: ${{ secrets.ALLURE_TOKEN }}\n          allure-project-id: \u003cPRJ_ID\u003e\n          allurectl-version: 2.15.4\n```\n\nThe information on releases can be found in the releases section of [allurectl repository.](https://github.com/allure-framework/allurectl/releases)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallure-framework%2Fsetup-allurectl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fallure-framework%2Fsetup-allurectl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fallure-framework%2Fsetup-allurectl/lists"}