{"id":21985190,"url":"https://github.com/loadmill/run-test-plan-action","last_synced_at":"2025-03-23T02:13:27.674Z","repository":{"id":65160679,"uuid":"372862282","full_name":"loadmill/run-test-plan-action","owner":"loadmill","description":null,"archived":false,"fork":false,"pushed_at":"2022-11-15T12:31:04.000Z","size":4055,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-22T22:20:25.942Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/loadmill.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-01T14:38:42.000Z","updated_at":"2022-10-31T12:50:13.000Z","dependencies_parsed_at":"2023-01-04T12:38:26.032Z","dependency_job_id":null,"html_url":"https://github.com/loadmill/run-test-plan-action","commit_stats":{"total_commits":27,"total_committers":4,"mean_commits":6.75,"dds":"0.18518518518518523","last_synced_commit":"7778d806ee025f263656634e8f0bd338ef84f360"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loadmill%2Frun-test-plan-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loadmill%2Frun-test-plan-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loadmill%2Frun-test-plan-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/loadmill%2Frun-test-plan-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/loadmill","download_url":"https://codeload.github.com/loadmill/run-test-plan-action/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245044584,"owners_count":20551902,"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":[],"created_at":"2024-11-29T18:12:50.031Z","updated_at":"2025-03-23T02:13:27.649Z","avatar_url":"https://github.com/loadmill.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Run Loadmill Test Plan action\n\nThis action runs a loadmill test plan, waits for it to complete and returns the result.\n\n## Inputs\n\n### `id`\n\n**Required** The test plan id to run.\n\n### `token`\n\n**Required** User token to run the test plan on behalf of. In order to run the test plan you will need to generate an [API Token](https://docs.loadmill.com/integrations/api-tokens).\n\nIt's recommended to use [GitHub's secrets](https://docs.github.com/en/actions/reference/encrypted-secrets) when using sensitive data like an API token\n\n### `additionalDescription`\n\nAdded at the end of the test plan run description (e.g. build number).\n\n### `labels`\n\nExecute flows that are assigned to a specific label (e.g. \"label1,label2\")\n\n### `labelsExpression`\n\nExecute flows that match the labels expression. An expression may contain the characters ( ) \u0026 | ! (e.g. '(label1 | label2) \u0026 !label3')\n\n### `parallel`\n\nSet the concurrency amount of running test suites in a test plan. Max concurrency is 10.\n\n### `pool`\n\nExecute tests from a dedicated agent's pool (when using private agent)\n\n### `parameters`\n\nOverride pre-defined parameter values via command line arguments by passing name=value pairs seperated by comma  (e.g. \"name=value,name2=value2\")\n\n### `branch`\n\nRun the test plan's suites from a Git branch\n\n### `healthcheckURL`\n\nThe test plan will start running only after a 200 status code is recieved from the given healthcheckURL argument. This health check will be performed every 5 seconds, up to 60 seconds or until the optional healthcheckTimeout arg (see below) is reached.\n\n### `healthcheckTimeout`\n\nIf healthcheckURL (see above) is given, the health check is performed until  healthcheckTimeout is reached.\n\n## Outputs\n\n### `result`\n\nThe result of the test plan run.\n\n## Example usage\n\n### A simple example\n```\nuses: loadmill/run-test-plan-action@v1\nwith:\n  id: '\u003ctest-plan-id\u003e'\n  token: '\u003cmy-generated-token\u003e'\n  additionalDescription: \"Commit ${{ github.ref }} by ${{ github.actor }}\"\n```\n\n### Using a secret called LOADMILL_API_TOKEN\n```\nuses: loadmill/run-test-plan-action@v1\nwith:\n  id: '\u003ctest-plan-id\u003e'\n  token: ${{ secrets.LOADMILL_API_TOKEN }}\n  additionalDescription: \"Commit ${{ github.ref }} by ${{ github.actor }}\"\n```\n\n### An example with labels\n```\nuses: loadmill/run-test-plan-action@v1\nwith:\n  id: '\u003ctest-plan-id\u003e'\n  token: '\u003cmy-generated-token\u003e'\n  additionalDescription: \"Commit ${{ github.ref }} by ${{ github.actor }}\"\n  labels: 'sanity,regression'\n```\n\n### An example with overrided parameters\n```\nuses: loadmill/run-test-plan-action@v1\nwith:\n  id: '\u003ctest-plan-id\u003e'\n  token: '\u003cmy-generated-token\u003e'\n  additionalDescription: \"Commit ${{ github.ref }} by ${{ github.actor }}\"\n  labels: 'sanity,regression'\n  parameters: 'host=www.example.com,port:443'\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floadmill%2Frun-test-plan-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Floadmill%2Frun-test-plan-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Floadmill%2Frun-test-plan-action/lists"}