status_check_contexts

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

Overview

Name	status_check_contexts
Type	Resource
Id	github.repos.status_check_contexts

Fields

The following fields are returned by SELECT queries:

get_all_status_check_contexts

Response

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_all_status_check_contexts	select	owner, repo, branch		Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
add_status_check_contexts	insert	owner, repo, branch, contexts		Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
set_status_check_contexts	replace	owner, repo, branch, contexts		Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.
remove_status_check_contexts	delete	owner, repo, branch		Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

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
branch	string	The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use the GraphQL API.
owner	string	The account owner of the repository. The name is not case sensitive.
repo	string	The name of the repository without the .git extension. The name is not case sensitive.

SELECT examples

get_all_status_check_contexts

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

SELECT
*
FROM github.repos.status_check_contexts
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
AND branch = '{{ branch }}' -- required
;

INSERT examples

add_status_check_contexts

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

INSERT INTO github.repos.status_check_contexts (
contexts,
owner,
repo,
branch
)
SELECT 
'{{ contexts }}' /* required */,
'{{ owner }}',
'{{ repo }}',
'{{ branch }}'
;

Manifest

# Description fields are for documentation purposes
- name: status_check_contexts
props:
  - name: owner
    value: "{{ owner }}"
    description: Required parameter for the status_check_contexts resource.
  - name: repo
    value: "{{ repo }}"
    description: Required parameter for the status_check_contexts resource.
  - name: branch
    value: "{{ branch }}"
    description: Required parameter for the status_check_contexts resource.
  - name: contexts
    value:
      - "{{ contexts }}"
    description: |
      The name of the status checks

REPLACE examples

set_status_check_contexts

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

REPLACE github.repos.status_check_contexts
SET 
contexts = '{{ contexts }}'
WHERE 
owner = '{{ owner }}' --required
AND repo = '{{ repo }}' --required
AND branch = '{{ branch }}' --required
AND contexts = '{{ contexts }}' --required;

DELETE examples

remove_status_check_contexts

Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see GitHub's products in the GitHub Help documentation.

DELETE FROM github.repos.status_check_contexts
WHERE owner = '{{ owner }}' --required
AND repo = '{{ repo }}' --required
AND branch = '{{ branch }}' --required
;