{"id":19855004,"url":"https://github.com/stepci/runner","last_synced_at":"2025-10-10T14:32:59.379Z","repository":{"id":59387023,"uuid":"536497145","full_name":"stepci/runner","owner":"stepci","description":"Step CI Test Runner","archived":false,"fork":false,"pushed_at":"2025-04-05T18:33:54.000Z","size":286,"stargazers_count":20,"open_issues_count":6,"forks_count":26,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-10-10T02:26:14.994Z","etag":null,"topics":["hacktoberfest"],"latest_commit_sha":null,"homepage":"https://stepci.com","language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stepci.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,"zenodo":null}},"created_at":"2022-09-14T09:07:01.000Z","updated_at":"2025-10-02T08:04:50.000Z","dependencies_parsed_at":"2023-12-28T17:47:31.240Z","dependency_job_id":"8ec9e68e-5bed-48e0-9164-c627652e3214","html_url":"https://github.com/stepci/runner","commit_stats":{"total_commits":137,"total_committers":5,"mean_commits":27.4,"dds":"0.051094890510948954","last_synced_commit":"c734591b3e354fd6f76367b8d2e35e2784af63d6"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/stepci/runner","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stepci%2Frunner","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stepci%2Frunner/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stepci%2Frunner/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stepci%2Frunner/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stepci","download_url":"https://codeload.github.com/stepci/runner/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stepci%2Frunner/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279004176,"owners_count":26083688,"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","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["hacktoberfest"],"created_at":"2024-11-12T14:11:22.735Z","updated_at":"2025-10-10T14:32:54.371Z","avatar_url":"https://github.com/stepci.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Step CI Runner\n\nStep CI Test Runner\n\n## Installation\n\n```\nnpm install @stepci/runner\n```\n\n## Usage\n\n### Run workflow from file\n\n```js\nimport { runFromFile } from '@stepci/runner'\nrunFromFile('./examples/status.yml').then(console.log)\n```\n\n### Run workflow from config\n\n```js\nimport { run } from '@stepci/runner'\n\n// Example workflow\nconst workflow = {\n  version: \"1.0\",\n  name: \"Status Test\",\n  env: {\n    host: \"example.com\"\n  },\n  tests: {\n    example: {\n      steps: [{\n        name: \"GET request\",\n        http: {\n          url: \"https://${{env.host}}\",\n          method: \"GET\",\n          check: {\n            status: \"/^20/\"\n          }\n        }\n      }]\n    }\n  }\n}\n\nrun(workflow).then(console.log)\n```\n\n### Events\n\nIf you supply an `EventEmitter` as argument, you can subscribe to following events:\n\n- `step:http_request`, when a http request is made\n- `step:http_response`, when a http response is received\n- `step:grpc_request`, when a grpc request is made\n- `step:grpc_response`, when a grpc is received\n- `step:result`, when step finishes\n- `step:error`, when step errors\n- `test:result`, when test finishes\n- `workflow:result`, when workflow finishes\n- `loadtest:result`, when loadtest finishes\n\n**Example: Events**\n\n```js\nimport { run } from '@stepci/runner'\nimport { EventEmitter } from 'node:events'\n\n// Example workflow\nconst workflow = {\n  version: \"1.0\",\n  name: \"Status Test\",\n  env: {\n    host: \"example.com\"\n  },\n  tests: {\n    example: {\n      steps: [{\n        name: \"GET request\",\n        http: {\n          url: \"https://${{env.host}}\",\n          method: \"GET\",\n          check: {\n            status: \"/^20/\"\n          }\n        }\n      }]\n    }\n  }\n}\n\nconst ee = new EventEmitter()\nee.on('done', console.log)\nrun(workflow, { ee })\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstepci%2Frunner","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstepci%2Frunner","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstepci%2Frunner/lists"}