repo_immutable_releases

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

Overview

Name	repo_immutable_releases
Type	Resource
Id	github.repos.repo_immutable_releases

Fields

The following fields are returned by SELECT queries:

check_immutable_releases

Response if immutable releases are enabled

Name	Datatype	Description
enabled	boolean	Whether immutable releases are enabled for the repository.
enforced_by_owner	boolean	Whether immutable releases are enforced by the repository owner.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
check_immutable_releases	select	owner, repo		Shows whether immutable releases are enabled or disabled. Also identifies whether immutability is being enforced by the repository owner. The authenticated user must have admin read access to the repository.
enable_immutable_releases	replace	owner, repo		Enables immutable releases for a repository. The authenticated user must have admin access to the repository.
disable_immutable_releases	delete	owner, repo		Disables immutable releases for a repository. The authenticated user must have admin access to the repository.

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.
repo	string	The name of the repository without the .git extension. The name is not case sensitive.

SELECT examples

check_immutable_releases

Shows whether immutable releases are enabled or disabled. Also identifies whether immutability is being
enforced by the repository owner. The authenticated user must have admin read access to the repository.

SELECT
enabled,
enforced_by_owner
FROM github.repos.repo_immutable_releases
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
;

REPLACE examples

enable_immutable_releases

Enables immutable releases for a repository. The authenticated user must have admin access to the repository.

REPLACE github.repos.repo_immutable_releases
SET 
-- No updatable properties
WHERE 
owner = '{{ owner }}' --required
AND repo = '{{ repo }}' --required;

DELETE examples

disable_immutable_releases

Disables immutable releases for a repository. The authenticated user must have admin access to the repository.

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