GitHub

Developer tools OAuth, or a personal access token

Open issues, review pull requests and read repository state from any Windmill script, flow or app.

What you can do with GitHub

Complete, deployable projects built around GitHub — the fastest way to get something real running.

Set up in 2 steps

1

Connect from the Resources page

Open Resources, click Add a resource/API and pick github from the OAuth APIs list. Click Connect, allow access in the window that opens, then name the resource and save it. Windmill asks GitHub for the repo and workflow scopes.

2

Run your first script

Fork any script below and run it against one of your repositories.

Scripts

Building blocks, if none of the projects above fit. Fork one, run it, or call it as a step inside your own flow.

Notify of new Github repo stars

Script· trigger github Verified

List newly added issues

Script· trigger github Verified

Get Repository

Script github Verified

Create Issue

Script github Verified

Get Repo Star Count

Script github Verified

Get Repo Content

Script github Verified

Dispatch Workflow Run

Script github Verified

Get a user

Script github Verified

GitHub native trigger template script

Script github Verified

Get repository content

Script github Verified

Create Branch

Script github Verified

Follow a user

Script github Verified

Update a release

Script github Verified

Get GitHub Actions permissions for a repository

Script github Verified

Get a release by tag name

Script github Verified

Create or update a repository secret

Script github Verified

Get a public SSH key for the authenticated user

Script github Verified

List runner applications for a repository

Script github Verified

Unstar a repository for the authenticated user

Script github Verified

Unblock a user

Script github Verified

Create a team

Script github Verified

Set interaction restrictions for a repository

Script github Verified

Download an organization migration archive

Script github Verified

List gists for the authenticated user

Script github Verified

Redeliver a delivery for an app webhook

Script github Verified

Merge a pull request

Script github Verified

Get a job for a workflow run

Script github Verified

Delete access restrictions

Script github Verified

Get a webhook configuration for a repository

Script github Verified

List public repositories

Script github Verified

Flows

Multi-step workflows that already wire GitHub to something else.

All flows →

Trigger flows from GitHub

GitHub is not only a destination. These inbound paths are supported today.

Repository webhooks

Point a repository webhook at a flow's webhook URL and every push starts a run.

Pull request events

Subscribe to pull_request to run checks or gate a deploy.

Resource type

github — the shape of the credential every script on this page expects.

View raw schema →
FieldTypeRequiredWhat it is
tokenstringYes

All resource types

Questions

OAuth or a personal access token?

OAuth is one click and the token it stores does not expire. Reach for a personal access token when you script the setup, when you want a token scoped to fewer repositories, or when your instance has no OAuth client configured.

Classic or fine-grained token?

Either works. Fine-grained tokens are scoped per repository and expire.

There is no Connect button on my instance

Self-hosted instances need an OAuth client configured once by an admin before the tile appears. Until then, use the token.