https://github.com/simbo/github-workflow-dispatcher

A small HTTP server using node.js and the hapi framework, that enables you to trigger GitHub Actions workflows using simple links.
https://github.com/simbo/github-workflow-dispatcher

github-actions hapi node workflow-dispatch

Last synced: 11 months ago
JSON representation

A small HTTP server using node.js and the hapi framework, that enables you to trigger GitHub Actions workflows using simple links.

• Host: GitHub
• URL: https://github.com/simbo/github-workflow-dispatcher
• Owner: simbo
• License: mit
• Created: 2023-05-09T19:02:44.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-07-06T13:30:53.000Z (over 2 years ago)
• Last Synced: 2025-01-21T09:09:23.889Z (about 1 year ago)
• Topics: github-actions, hapi, node, workflow-dispatch
• Language: TypeScript
• Homepage:
• Size: 359 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# GitHub Workflow Dispatcher

[![License MIT](https://img.shields.io/badge/license-MIT-cccccc)](http://simbo.mit-license.org/)

[![GitHub Repo](https://img.shields.io/badge/repo-public-87ceeb)](https://github.com/simbo/github-workflow-dispatcher)

![Native Typescript Support](https://img.shields.io/badge/types-Typescript-0c7dbe)

[![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)

A small HTTP server using node.js and the [hapi](https://hapi.dev/) framework,

that enables you to trigger GitHub Actions workflows using simple links (aka

HTTP `GET` requests).

## About

As you might know, GitHub Actions workflows can be triggered on demand using the

[`workflow_dispatch`](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#workflow_dispatch)

event. However, to trigger such an event, a HTTP `POST` request with payload and

authentication is required. That way, you are not able to trigger a workflow

using a simple link.

The _GitHub Workflow Dispatcher_ solves this problem. It offers a `GET` route

that can pass-through a `workflow_dispatch` event with optional inputs to the

GitHub API. For authentication, it uses GitHub OAuth to create a user token that

is used for further requests. This way it is ensured, that only users with

sufficient privileges can trigger a workflow.

To use _GitHub Workflow Dispatcher_ with your GitHub Enterprise environment, you

need to host your own instance using the respective

[environment options](https://github.com/simbo/github-workflow-dispatcher/blob/main/.env-sample#L18-L20).

## Features

- **General**

  - 👔 full support for GitHub Enterprise (and also GitHub.com, of course)

  - 🪪 using actual user privileges for accessing repository workflows

  - 🐳 prepared for containerized deployment using Docker

  - 🛠️ customizable configuration depending on environment

  - 🧑‍💻 native Typescript project following strict rules and latest ECMAScript

    standards

- **Backend**

  - 🧩 modular architecture via hapi's plugin system

  - 🐙 GitHub OAuth and API implementation using latest specification and

    official `@octokit/*` packages

  - 🗄️ server-side in-memory caching of precompiled responses

  - 🔒 secure cookie storage of authorization artifacts using AES 256 CBC

    encryption

  - 🎈 no persistent storage required

- **Frontend**

  - 💎 slick and simple, GitHub-inspired design

  - 🪄 in-place usage documentation including dispatch URL generator

  - 🤝 meaningfull error pages

  - 🚀 optimized CSS and JavaScript assets without frameworks or 3rd-party

    dependencies

  - 🌗 switching light and dark theme depending on user preference

## Development

### Requirements

- node.js >= 18.x

- git-secret

- docker (optional)

### Git Secrets

This project uses [`git-secret`](https://github.com/sobolevn/git-secret) to

store sensitive information in the git repository.

Before being able to decrypt the respective files, your public GPG key needs to

be added to the list of allowed users.

### Setup

```sh

# clone project

git clone git@github.com:simbo/github-workflow-dispatcher.git

# install dependencies

npm i

# decrypt secret files

git secret reveal

# start watch tasks for server, js and css concurrently

npm start

```

### Docker

The project contains a `Dockerfile` to create an image.

The docker build expects a `.env-production` file to be present (revealed).

```sh

# build docker image

docker build -t github-workflow-dispatcher:VERSION .

# start docker container

docker run -itd -p 8080:3000 -e BASE_URL=http://localhost:8080/ github-workflow-dispatcher:VERSION

```

## License and Author

[MIT © Simon Lepel](https://simbo.mit-license.org/)