{"id":14985888,"url":"https://github.com/doowb/trigger-workflow","last_synced_at":"2025-04-11T22:11:56.853Z","repository":{"id":252317544,"uuid":"840059234","full_name":"doowb/trigger-workflow","owner":"doowb","description":"Easily trigger GitHub workflows, get latest workflow runs, and wait for workflow runs to complete.","archived":false,"fork":false,"pushed_at":"2024-09-10T16:47:55.000Z","size":71,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-11T22:11:51.524Z","etag":null,"topics":["actions","workflows"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/doowb.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":"2024-08-08T22:20:32.000Z","updated_at":"2025-01-03T11:19:03.000Z","dependencies_parsed_at":"2024-08-09T01:28:17.044Z","dependency_job_id":"5aed4c24-6f9c-44bc-858d-8370f51ab522","html_url":"https://github.com/doowb/trigger-workflow","commit_stats":{"total_commits":24,"total_committers":2,"mean_commits":12.0,"dds":0.08333333333333337,"last_synced_commit":"128ebcd2129f75bdf7564b3f4ab5b05939c19867"},"previous_names":["doowb/trigger-workflow"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doowb%2Ftrigger-workflow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doowb%2Ftrigger-workflow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doowb%2Ftrigger-workflow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/doowb%2Ftrigger-workflow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/doowb","download_url":"https://codeload.github.com/doowb/trigger-workflow/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248487690,"owners_count":21112190,"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":["actions","workflows"],"created_at":"2024-09-24T14:11:50.218Z","updated_at":"2025-04-11T22:11:56.828Z","avatar_url":"https://github.com/doowb.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# trigger-workflow [![NPM version](https://img.shields.io/npm/v/trigger-workflow.svg?style=flat)](https://www.npmjs.com/package/trigger-workflow) [![NPM monthly downloads](https://img.shields.io/npm/dm/trigger-workflow.svg?style=flat)](https://npmjs.org/package/trigger-workflow) [![NPM total downloads](https://img.shields.io/npm/dt/trigger-workflow.svg?style=flat)](https://npmjs.org/package/trigger-workflow)\n\n\u003e Easily trigger GitHub workflows, get latest workflow runs, and wait for workflow runs to complete.\n\nPlease consider following this project's author, [Brian Woodward](https://github.com/doowb), and consider starring the project to show your :heart: and support.\n\n## Install\n\nInstall with [npm](https://www.npmjs.com/):\n\n```sh\n$ npm install --save trigger-workflow\n```\n\n## Usage\n\n**Example**\n\n```ts\nimport { triggerWorkflow, waitForCompletion } from 'trigger-workflow';\n\nasync function main() {\n  const token = 'ghp_your_github_token_here';\n  const owner = 'foo';\n  const repo = 'bar';\n\n  const run_id = await triggerWorkflow({\n    owner,\n    repo,\n    token,\n    workflow_id: 'my-workflow.yml',\n    ref: 'main'\n  });\n\n  await waitForCompletion({ owner, repo, token, run_id });\n\n  console.log(`Workflow triggered with run_id: ${run_id}`);\n}\n\nmain().catch(console.error);\n```\n\n## API\n\nThis package provides two functions: `triggerWorkflow` and `waitForCompletion`.\n\n### triggerWorkflow\n\nTriggers a GitHub Actions workflow and returns the `run_id` of the triggered workflow.\n\n**Example**\n\n```ts\nimport { triggerWorkflow } from 'trigger-workflow';\n\nasync function main() {\n  const run_id = await triggerWorkflow({\n    owner: 'foo',\n    repo: 'bar',\n    token: 'ghp_your_github_token_here',\n    workflow_id: 'my-workflow.yml',\n    ref: 'main'\n  });\n\n  console.log(`Workflow triggered with run_id: ${run_id}`);\n}\n\nmain().catch(console.error);\n```\n\n### waitForCompletion\n\nWaits for a GitHub Actions workflow to complete, polling at a specified interval.\n\n**Example**\n\n```ts\nimport { triggerWorkflow, waitForCompletion } from 'trigger-workflow';\n\nasync function main() {\n  const token = 'ghp_your_github_token_here';\n  const run_id = '1234567890';\n  const owner = 'foo';\n  const repo = 'bar';\n\n  await waitForCompletion({\n    owner,\n    repo,\n    token,\n    run_id,\n    interval: 5000,\n  });\n\n  console.log('Workflow completed!');\n}\n\nmain().catch(console.error);\n```\n\n## About\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eContributing\u003c/strong\u003e\u003c/summary\u003e\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eRunning Tests\u003c/strong\u003e\u003c/summary\u003e\n\nRunning and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:\n\n```sh\n$ npm install \u0026\u0026 npm test\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\u003cstrong\u003eBuilding docs\u003c/strong\u003e\u003c/summary\u003e\n\n_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_\n\nTo generate the readme, run the following command:\n\n```sh\n$ npm install -g verbose/verb#dev verb-generate-readme \u0026\u0026 verb\n```\n\n\u003c/details\u003e\n\n### Contributors\n\n| **Commits** | **Contributor** |  \n| --- | --- |  \n| 19 | [doowb](https://github.com/doowb) |  \n| 2  | [jonschlinkert](https://github.com/jonschlinkert) |  \n\n### Author\n\n**Brian Woodward**\n\n* [GitHub Profile](https://github.com/doowb)\n* [Twitter Profile](https://twitter.com/doowb)\n* [LinkedIn Profile](https://linkedin.com/in/woodwardbrian)\n\n### License\n\nCopyright © 2024, [Brian Woodward](https://github.com/doowb).\nReleased under the [MIT License](LICENSE).\n\n***\n\n_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.8.0, on September 10, 2024._","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoowb%2Ftrigger-workflow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdoowb%2Ftrigger-workflow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdoowb%2Ftrigger-workflow/lists"}