immutable_releases_settings

Creates, updates, deletes, gets or lists an immutable_releases_settings resource.

Overview

Name	immutable_releases_settings
Type	Resource
Id	github.orgs.immutable_releases_settings

Fields

The following fields are returned by SELECT queries:

get_immutable_releases_settings

Immutable releases settings response

Name	Datatype	Description
enforced_repositories	string	The policy that controls how immutable releases are enforced in the organization. (all, none, selected) (example: all)
selected_repositories_url	string	The API URL to use to get or set the selected repositories for immutable releases enforcement, when enforced_repositories is set to selected.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_immutable_releases_settings	select	org		Gets the immutable releases policy for repositories in an organization. OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.
set_immutable_releases_settings	replace	org, enforced_repositories		Sets the immutable releases policy for repositories in an organization. OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

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
org	string	The organization name. The name is not case sensitive.

SELECT examples

get_immutable_releases_settings

Gets the immutable releases policy for repositories in an organization.

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

SELECT
enforced_repositories,
selected_repositories_url
FROM github.orgs.immutable_releases_settings
WHERE org = '{{ org }}' -- required
;

REPLACE examples

set_immutable_releases_settings

Sets the immutable releases policy for repositories in an organization.

OAuth tokens and personal access tokens (classic) need the admin:org scope to use this endpoint.

REPLACE github.orgs.immutable_releases_settings
SET 
enforced_repositories = '{{ enforced_repositories }}',
selected_repository_ids = '{{ selected_repository_ids }}'
WHERE 
org = '{{ org }}' --required
AND enforced_repositories = '{{ enforced_repositories }}' --required;