security_fixes
Creates, updates, deletes, gets or lists a security_fixes resource.
Overview
| Name | security_fixes |
| Type | Resource |
| Id | github.repos.security_fixes |
Fields
The following fields are returned by SELECT queries:
- check_automated_security_fixes
Response if Dependabot is enabled
| Name | Datatype | Description |
|---|---|---|
enabled | boolean | Whether Dependabot security updates are enabled for the repository. |
paused | boolean | Whether Dependabot security updates are paused for the repository. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
check_automated_security_fixes | select | owner, repo | Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "Configuring Dependabot security updates". | |
enable_automated_security_fixes | exec | owner, repo | Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "Configuring Dependabot security updates". | |
disable_automated_security_fixes | exec | owner, repo | Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "Configuring Dependabot security updates". |
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_automated_security_fixes
Shows whether Dependabot security updates are enabled, disabled or paused for a repository. The authenticated user must have admin read access to the repository. For more information, see "Configuring Dependabot security updates".
SELECT
enabled,
paused
FROM github.repos.security_fixes
WHERE owner = '{{ owner }}' -- required
AND repo = '{{ repo }}' -- required
;
Lifecycle Methods
- enable_automated_security_fixes
- disable_automated_security_fixes
Enables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "Configuring Dependabot security updates".
EXEC github.repos.security_fixes.enable_automated_security_fixes
@owner='{{ owner }}' --required,
@repo='{{ repo }}' --required
;
Disables Dependabot security updates for a repository. The authenticated user must have admin access to the repository. For more information, see "Configuring Dependabot security updates".
EXEC github.repos.security_fixes.disable_automated_security_fixes
@owner='{{ owner }}' --required,
@repo='{{ repo }}' --required
;