runner_jit_configs

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

Overview

Name	runner_jit_configs
Type	Resource
Id	github.actions.runner_jit_configs

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
generate_runner_jitconfig_for_repo	insert	owner, repo, name, runner_group_id, labels		Generates a configuration that can be passed to the runner application at startup. The authenticated user must have admin access to the repository. OAuth tokens and personal access tokens (classic) need therepo scope to use this endpoint.
generate_runner_jitconfig_for_org	insert	org, name, runner_group_id, labels		Generates a configuration that can be passed to the runner application at startup. The authenticated user must have admin access to the organization. OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo 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.
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.

INSERT examples

generate_runner_jitconfig_for_repo

Generates a configuration that can be passed to the runner application at startup.

The authenticated user must have admin access to the repository.

OAuth tokens and personal access tokens (classic) need therepo scope to use this endpoint.

INSERT INTO github.actions.runner_jit_configs (
name,
runner_group_id,
labels,
work_folder,
owner,
repo
)
SELECT 
'{{ name }}' /* required */,
{{ runner_group_id }} /* required */,
'{{ labels }}' /* required */,
'{{ work_folder }}',
'{{ owner }}',
'{{ repo }}'
RETURNING
encoded_jit_config,
runner
;

generate_runner_jitconfig_for_org

Generates a configuration that can be passed to the runner application at startup.

The authenticated user must have admin access to the organization.

OAuth tokens and personal access tokens (classic) need theadmin:org scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the repo scope to use this endpoint.

INSERT INTO github.actions.runner_jit_configs (
name,
runner_group_id,
labels,
work_folder,
org
)
SELECT 
'{{ name }}' /* required */,
{{ runner_group_id }} /* required */,
'{{ labels }}' /* required */,
'{{ work_folder }}',
'{{ org }}'
RETURNING
encoded_jit_config,
runner
;

Manifest

# Description fields are for documentation purposes
- name: runner_jit_configs
props:
  - name: owner
    value: "{{ owner }}"
    description: Required parameter for the runner_jit_configs resource.
  - name: repo
    value: "{{ repo }}"
    description: Required parameter for the runner_jit_configs resource.
  - name: org
    value: "{{ org }}"
    description: Required parameter for the runner_jit_configs resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the new runner.
  - name: runner_group_id
    value: {{ runner_group_id }}
    description: |
      The ID of the runner group to register the runner to.
  - name: labels
    value:
      - "{{ labels }}"
    description: |
      The names of the custom labels to add to the runner. **Minimum items**: 1. **Maximum items**: 100.
  - name: work_folder
    value: "{{ work_folder }}"
    description: |
      The working directory to be used for job execution, relative to the runner install directory.
    default: _work