repo_pages_deployments

Creates, updates, deletes, gets or lists a repo_pages_deployments resource.

Overview

Name	repo_pages_deployments
Type	Resource
Id	github.repos.repo_pages_deployments

Fields

The following fields are returned by SELECT queries:

get_pages_deployment

Response

Name	Datatype	Description
status	string	The current status of the deployment. (deployment_in_progress, syncing_files, finished_file_sync, updating_pages, purging_cdn, deployment_cancelled, deployment_failed, deployment_content_failed, deployment_attempt_error, deployment_lost, succeed)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_pages_deployment	select	owner, repo, pages_deployment_id		Gets the current status of a GitHub Pages deployment. The authenticated user must have read permission for the GitHub Pages site.
cancel_pages_deployment	insert	owner, repo, pages_deployment_id		Cancels a GitHub Pages deployment. The authenticated user must have write permissions for the GitHub Pages site.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
owner	string	The account owner of the repository. The name is not case sensitive.
pages_deployment_id		The ID of the Pages deployment. You can also give the commit SHA of the deployment.
repo	string	The name of the repository without the .git extension. The name is not case sensitive.

SELECT examples

get_pages_deployment

Gets the current status of a GitHub Pages deployment.

The authenticated user must have read permission for the GitHub Pages site.

SELECT
status
FROM github.repos.repo_pages_deployments
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
AND pages_deployment_id = '{{ pages_deployment_id }}' -- required
;

INSERT examples

cancel_pages_deployment

Cancels a GitHub Pages deployment.

The authenticated user must have write permissions for the GitHub Pages site.

INSERT INTO github.repos.repo_pages_deployments (
owner,
repo,
pages_deployment_id
)
SELECT 
'{{ owner }}',
'{{ repo }}',
'{{ pages_deployment_id }}'
;

Manifest

# Description fields are for documentation purposes
- name: repo_pages_deployments
props:
  - name: owner
    value: "{{ owner }}"
    description: Required parameter for the repo_pages_deployments resource.
  - name: repo
    value: "{{ repo }}"
    description: Required parameter for the repo_pages_deployments resource.
  - name: pages_deployment_id
    value: "{{ pages_deployment_id }}"
    description: Required parameter for the repo_pages_deployments resource.