GitHub: Create a Git Hub Pages deployment

← Repos operations · Get started

Operation github.repos_create_pages_deployment

Provider route: POST /repos/{owner}/{repo}/pages/deployments. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["repos"]["reposCreatePagesDeployment"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.repos.reposCreatePagesDeployment(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.repos.repos_create_pages_deployment(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.owner	string	Required within parent
path.repo	string	Required within parent
body	object	Required within parent	The object used to create GitHub Pages deployment
body.artifact_id	number	Optional	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.
body.artifact_url	string	Optional	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.
body.environment	string	Optional	The target environment for this GitHub Pages deployment. Default: github-pages
body.oidc_token	string	Required within parent	The OIDC token issued by GitHub Actions certifying the origin of the deployment.
body.pages_build_version	string	Required within parent	A unique string that represents the version of the build for this deployment. Default: GITHUB_SHA

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Create a Git Hub Pages deployment — response body

Referenced models: Create a Git Hub Pages deployment — response body

Schemas

Create a Git Hub Pages deployment — response body

Field	Type	Presence	Description and constraints
$	object	Root	The GitHub Pages deployment status.
id	JSON	Required within parent	The ID of the GitHub Pages deployment. This is the Git SHA of the deployed commit.
id (anyOf 1)	JSON	Alternative
id (anyOf 1) (anyOf 1)	integer	Alternative
id (anyOf 1) (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
id (anyOf 2)	string	Alternative
page_url	string	Required within parent	The URI to the deployed GitHub Pages. Format: uri
preview_url	string	Optional	The URI to the deployed GitHub Pages preview. Format: uri
status_url	string	Required within parent	The URI to monitor GitHub Pages deployment status. Format: uri

Policy, approvals and errors

SDK function policy ID: github.repos_create_pages_deployment. Catalog operation: repos/create-pages-deployment. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source