gitea.cli.actions.runner.update

update

Disable or re-enable one Actions runner.

Disabling is the reversible alternative to gitea-cli actions runner delete: the runner stays registered and stops taking jobs, so it can be brought back without being registered again. Deleting removes the registration, and a machine that is meant to return has to re-register with a fresh token.

--state is required. There is no partial update of a runner, so an update says which of the two states it means rather than defaulting to one of them.

Classes

Functions:

gitea.cli.actions.runner.update.update_runner_command

update_runner_command(
    ctx: Context,
    runner_id: Annotated[
        int, Option("--runner-id", help=RUNNER_ID_HELP)
    ],
    state: Annotated[
        RunnerState,
        Option("--state", help=RUNNER_STATE_HELP),
    ],
    owner: Annotated[
        str | None, Option("--owner", help=OWNER_SCOPE_HELP)
    ] = None,
    repository: Annotated[
        str | None,
        Option("--repository", help=REPOSITORY_SCOPE_HELP),
    ] = None,
    admin: Annotated[
        bool, Option("--admin", help=ADMIN_HELP)
    ] = False,
    account_name: Annotated[
        str | None,
        Option(
            "--account-name",
            help="Name of the account to use for authentication.",
        ),
    ] = None,
    token: Annotated[
        str | None,
        Option(
            "--token",
            help="Token for authentication. If not provided, the token from the specified account will be used.",
        ),
    ] = None,
    base_url: Annotated[
        str | None,
        Option(
            "--base-url",
            help="Base URL of the Gitea platform. If not provided, the base URL from the specified account will be used.",
        ),
    ] = None,
) -> None

Disable or re-enable one Actions runner.

Parameters:

Name	Type	Description	Default
ctx	Context	The Typer context.	required
runner_id	Annotated[int, Option('--runner-id', help=RUNNER_ID_HELP)]	The ID of the runner.	required
state	Annotated[RunnerState, Option('--state', help=RUNNER_STATE_HELP)]	The state to put the runner in.	required
owner	Annotated[str | None, Option('--owner', help=OWNER_SCOPE_HELP)]	The owner of the repository, or the organization itself.	None
repository	Annotated[str | None, Option('--repository', help=REPOSITORY_SCOPE_HELP)]	The name of the repository, to narrow the owner to one of its repositories.	None
admin	Annotated[bool, Option('--admin', help=ADMIN_HELP)]	Whether to address the whole instance.	False
account_name	Annotated[str | None, Option('--account-name', help='Name of the account to use for authentication.')]	Name of the account to use for authentication.	None
token	Annotated[str | None, Option('--token', help='Token for authentication. If not provided, the token from the specified account will be used.')]	Token for authentication.	None
base_url	Annotated[str | None, Option('--base-url', help='Base URL of the Gitea platform. If not provided, the base URL from the specified account will be used.')]	Base URL of the Gitea platform.	None

Source code in src/gitea/cli/actions/runner/update.py

def update_runner_command(
    ctx: typer.Context,
    runner_id: Annotated[int, typer.Option("--runner-id", help=RUNNER_ID_HELP)],
    state: Annotated[RunnerState, typer.Option("--state", help=RUNNER_STATE_HELP)],
    owner: Annotated[str | None, typer.Option("--owner", help=OWNER_SCOPE_HELP)] = None,
    repository: Annotated[str | None, typer.Option("--repository", help=REPOSITORY_SCOPE_HELP)] = None,
    admin: Annotated[bool, typer.Option("--admin", help=ADMIN_HELP)] = False,
    account_name: Annotated[
        str | None,
        typer.Option(
            "--account-name",
            help="Name of the account to use for authentication.",
        ),
    ] = None,
    token: Annotated[
        str | None,
        typer.Option(
            "--token",
            help="Token for authentication. If not provided, the token from the specified account will be used.",
        ),
    ] = None,
    base_url: Annotated[
        str | None,
        typer.Option(
            "--base-url",
            help="Base URL of the Gitea platform. If not provided, the base URL from the specified account will be used.",
        ),
    ] = None,
) -> None:
    """Disable or re-enable one Actions runner.

    Args:
        ctx: The Typer context.
        runner_id: The ID of the runner.
        state: The state to put the runner in.
        owner: The owner of the repository, or the organization itself.
        repository: The name of the repository, to narrow the owner to one of its repositories.
        admin: Whether to address the whole instance.
        account_name: Name of the account to use for authentication.
        token: Token for authentication.
        base_url: Base URL of the Gitea platform.

    """
    from typing import Any  # noqa: PLC0415

    from gitea.cli.utils.api import execute_api_command  # noqa: PLC0415
    from gitea.cli.utils.auth import get_auth_params  # noqa: PLC0415
    from gitea.cli.utils.options import reporting_scope_errors  # noqa: PLC0415
    from gitea.client.gitea import Gitea  # noqa: PLC0415

    token, base_url = get_auth_params(
        config_path=ctx.obj.get("config_path"),
        account_name=account_name,
        token=token,
        base_url=base_url,
    )

    def api_call() -> tuple[dict[str, Any] | list[dict[str, Any]], dict[str, Any]]:
        """Update the runner.

        Returns:
            A tuple containing the runner as it now stands and metadata.

        """
        with reporting_scope_errors(COMMAND_NAME), Gitea(token=token, base_url=base_url) as client:
            return client.actions.update_runner(
                runner_id=runner_id,
                disabled=state is RunnerState.DISABLED,
                owner=owner,
                repository=repository,
                admin=admin,
            )

    execute_api_command(api_call=api_call, base_url=base_url, command_name=COMMAND_NAME)