GitHub: Update a code quality setup configuration

← Code quality operations · Get started

Operation github.code_quality_update_setup

Provider route: PATCH /repos/{owner}/{repo}/code-quality/setup. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/github with npm, or alter-sdk-github with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { GitHubIntegration } from "@alter-ai/github";

async function execute(input: Parameters<GitHubIntegration["codeQuality"]["codeQualityUpdateSetup"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new GitHubIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.codeQuality.codeQualityUpdateSetup(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_github import GitHubIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = GitHubIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.code_quality.code_quality_update_setup(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.owner	string	Required within parent
path.repo	string	Required within parent
body	Model	Required within parent	Expand Update a code quality setup configuration — request body — body

Referenced models: Update a code quality setup configuration — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	JSON	Root
$ (anyOf 1)	Model	Alternative	Expand Re-run a workflow — response body
$ (anyOf 2)	Model	Alternative	Expand Update a code quality setup configuration — response body — run id, run url

Referenced models: Update a code quality setup configuration — response body — run id, run url, Re-run a workflow — response body

Schemas

Update a code quality setup configuration — response body — run id, run url

Field	Type	Presence	Description and constraints
$	object	Root	You can use `run_url` to track the status of the run. This includes a property status and conclusion. You should not rely on this always being an actions workflow run object.
run_id	JSON	Optional
run_id (anyOf 1)	integer	Alternative	ID of the corresponding run.
run_id (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
run_url	string	Optional	URL of the corresponding run.

Re-run a workflow — response body

Field	Type	Presence	Description and constraints
$	object	Root	An object without any properties. Additional keys: not allowed

Update a code quality setup configuration — request body — body

Field	Type	Presence	Description and constraints
$	object	Root	Configuration for code quality setup. Additional keys: not allowed
ai_findings_option	string	Optional	Whether AI findings run for Code Quality on this repository. One of: disabled, on_push
languages	array	Optional	Languages to be analyzed.
languages[]	string	Each item	One of: csharp, go, java-kotlin, javascript-typescript, python, ruby
runner_label	JSON	Optional
runner_label (anyOf 1)	string	Alternative	Runner label to be used if the runner type is labeled.
runner_label (anyOf 2)	null	Alternative
runner_type	string	Optional	Runner type to be used. One of: standard, labeled
state	string	Optional	The desired state of code quality setup. One of: configured, not-configured
$ (anyOf 1)	JSON	Alternative
$ (anyOf 2)	JSON	Alternative
$ (anyOf 3)	JSON	Alternative
$ (anyOf 4)	JSON	Alternative
$ (anyOf 5)	JSON	Alternative

Policy, approvals and errors

SDK function policy ID: github.code_quality_update_setup. Catalog operation: code-quality/update-setup. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"X-GitHub-Api-Version": "2026-03-10", "User-Agent": "Alter", "Accept": "application/vnd.github+json"}

Official provider source