provider repos POST /repos/{owner}/{repo}/pages/deployments
@utdk/github /repos/{owner}/{repo}/pages/deployments
Create a GitHub Pages deployment
Create a GitHub Pages deployment for a repository. The authenticated user must have write permission to the repository.
owner path required
The account owner of the repository. The name is not case sensitive.
string
repo path required
The name of the repository without the `.git` extension. The name is not case sensitive.
string

Try it

Authentication
Configure credentials for GitHub v3 REST API
Gateway
The gateway proxies requests and injects credentials server-side. Configure credentials above, then enter your gateway URL.

Saved automatically to browser storage.

repos.createPagesDeployment
POST/repos/{owner}/{repo}/pages/deployments
Create a GitHub Pages deployment for a repository. The authenticated user must have write permission to the repository.

Parameters

required

The account owner of the repository. The name is not case sensitive.

required

The name of the repository without the `.git` extension. The name is not case sensitive.

Input

The ID of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required.

The URL of an artifact that contains the .zip or .tar of static assets to deploy. The artifact belongs to the repository. Either `artifact_id` or `artifact_url` are required.

The target environment for this GitHub Pages deployment.

required

A unique string that represents the version of the build for this deployment.

required

The OIDC token issued by GitHub Actions certifying the origin of the deployment.

Enter a gateway URL above to enable sending.

Code snippet
Updates live as you fill in the form above.

TypeScript

import github from '@utdk/github';

await github.repos.createPagesDeployment({
  "environment": "github-pages",
  "pages_build_version": "GITHUB_SHA"
})