{"id":21158297,"url":"https://github.com/simbo/github-workflow-dispatcher","last_synced_at":"2025-03-14T15:27:12.830Z","repository":{"id":163280926,"uuid":"638630916","full_name":"simbo/github-workflow-dispatcher","owner":"simbo","description":"A small HTTP server using node.js and the hapi framework, that enables you to trigger GitHub Actions workflows using simple links.","archived":false,"fork":false,"pushed_at":"2023-07-06T13:30:53.000Z","size":368,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-01-21T09:09:23.889Z","etag":null,"topics":["github-actions","hapi","node","workflow-dispatch"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/simbo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2023-05-09T19:02:44.000Z","updated_at":"2023-05-10T01:38:46.000Z","dependencies_parsed_at":null,"dependency_job_id":"0c1b50b2-d8f3-4a05-88d0-744103aa2862","html_url":"https://github.com/simbo/github-workflow-dispatcher","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simbo%2Fgithub-workflow-dispatcher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simbo%2Fgithub-workflow-dispatcher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simbo%2Fgithub-workflow-dispatcher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/simbo%2Fgithub-workflow-dispatcher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/simbo","download_url":"https://codeload.github.com/simbo/github-workflow-dispatcher/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243599820,"owners_count":20317171,"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":["github-actions","hapi","node","workflow-dispatch"],"created_at":"2024-11-20T12:19:38.442Z","updated_at":"2025-03-14T15:27:12.782Z","avatar_url":"https://github.com/simbo.png","language":"TypeScript","readme":"# GitHub Workflow Dispatcher\n\n[![License MIT](https://img.shields.io/badge/license-MIT-cccccc)](http://simbo.mit-license.org/)\n[![GitHub Repo](https://img.shields.io/badge/repo-public-87ceeb)](https://github.com/simbo/github-workflow-dispatcher)\n![Native Typescript Support](https://img.shields.io/badge/types-Typescript-0c7dbe)\n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/simbo/github-workflow-dispatcher/ci.yml?branch=main)](https://github.com/simbo/github-workflow-dispatcher/actions/workflows/ci.yml)\n\n\u003c!-- [![Coveralls Coverage](https://img.shields.io/coveralls/github/simbo/github-workflow-dispatcher)](https://coveralls.io/github/simbo/github-workflow-dispatcher) --\u003e\n\nA small HTTP server using node.js and the [hapi](https://hapi.dev/) framework,\nthat enables you to trigger GitHub Actions workflows using simple links (aka\nHTTP `GET` requests).\n\n## About\n\nAs you might know, GitHub Actions workflows can be triggered on demand using the\n[`workflow_dispatch`](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch)\nevent. However, to trigger such an event, a HTTP `POST` request with payload and\nauthentication is required. That way, you are not able to trigger a workflow\nusing a simple link.\n\nThe _GitHub Workflow Dispatcher_ solves this problem. It offers a `GET` route\nthat can pass-through a `workflow_dispatch` event with optional inputs to the\nGitHub API. For authentication, it uses GitHub OAuth to create a user token that\nis used for further requests. This way it is ensured, that only users with\nsufficient privileges can trigger a workflow.\n\nTo use _GitHub Workflow Dispatcher_ with your GitHub Enterprise environment, you\nneed to host your own instance using the respective\n[environment options](https://github.com/simbo/github-workflow-dispatcher/blob/main/.env-sample#L18-L20).\n\n## Features\n\n- **General**\n\n  - 👔 full support for GitHub Enterprise (and also GitHub.com, of course)\n  - 🪪 using actual user privileges for accessing repository workflows\n  - 🐳 prepared for containerized deployment using Docker\n  - 🛠️ customizable configuration depending on environment\n  - 🧑‍💻 native Typescript project following strict rules and latest ECMAScript\n    standards\n\n- **Backend**\n\n  - 🧩 modular architecture via hapi's plugin system\n  - 🐙 GitHub OAuth and API implementation using latest specification and\n    official `@octokit/*` packages\n  - 🗄️ server-side in-memory caching of precompiled responses\n  - 🔒 secure cookie storage of authorization artifacts using AES 256 CBC\n    encryption\n  - 🎈 no persistent storage required\n\n- **Frontend**\n  - 💎 slick and simple, GitHub-inspired design\n  - 🪄 in-place usage documentation including dispatch URL generator\n  - 🤝 meaningfull error pages\n  - 🚀 optimized CSS and JavaScript assets without frameworks or 3rd-party\n    dependencies\n  - 🌗 switching light and dark theme depending on user preference\n\n## Development\n\n### Requirements\n\n- node.js \u003e= 18.x\n- git-secret\n- docker (optional)\n\n### Git Secrets\n\nThis project uses [`git-secret`](https://github.com/sobolevn/git-secret) to\nstore sensitive information in the git repository.\n\nBefore being able to decrypt the respective files, your public GPG key needs to\nbe added to the list of allowed users.\n\n### Setup\n\n```sh\n# clone project\ngit clone git@github.com:simbo/github-workflow-dispatcher.git\n\n# install dependencies\nnpm i\n\n# decrypt secret files\ngit secret reveal\n\n# start watch tasks for server, js and css concurrently\nnpm start\n```\n\n### Docker\n\nThe project contains a `Dockerfile` to create an image.\n\nThe docker build expects a `.env-production` file to be present (revealed).\n\n```sh\n# build docker image\ndocker build -t github-workflow-dispatcher:VERSION .\n\n# start docker container\ndocker run -itd -p 8080:3000 -e BASE_URL=http://localhost:8080/ github-workflow-dispatcher:VERSION\n```\n\n## License and Author\n\n[MIT \u0026copy; Simon Lepel](https://simbo.mit-license.org/)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimbo%2Fgithub-workflow-dispatcher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsimbo%2Fgithub-workflow-dispatcher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsimbo%2Fgithub-workflow-dispatcher/lists"}