gitea.cli.actions.secret.list

list

List the Actions secrets of a repository or an organization.

A secret's value is never listed: Gitea stores it write-only, so what comes back is the name, the description and when it was set. That is all there is to read, and it is what makes a secret a secret rather than a variable.

Which scope is asked for follows the usual convention, minus one: --owner with --repository lists a repository's own and --owner alone lists an organization's, but omitting both is refused rather than listing the authenticated account's. Gitea offers no such endpoint, and answering the invocation with an empty list is exactly what the missing endpoint would look like. Setting and deleting do work at that scope - see gitea-cli actions secret set.

A job sees the secrets of every scope above it, so a repository's listing is not the set of secrets its workflows can read.

Functions:

gitea.cli.actions.secret.list.list_secrets_command

list_secrets_command(
    ctx: Context,
    owner: Annotated[
        str | None, Option("--owner", help=OWNER_SCOPE_HELP)
    ] = None,
    repository: Annotated[
        str | None,
        Option("--repository", help=REPOSITORY_SCOPE_HELP),
    ] = None,
    page: Annotated[
        int | None,
        Option(
            "--page", help="The page number for pagination."
        ),
    ] = None,
    limit: Annotated[
        int | None,
        Option(
            "--limit",
            help="The number of secrets per page.",
        ),
    ] = None,
    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

List the Actions secrets of a repository or an organization.

Parameters:

Name	Type	Description	Default
ctx	Context	The Typer context.	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
page	Annotated[int | None, Option('--page', help='The page number for pagination.')]	The page number for pagination.	None
limit	Annotated[int | None, Option('--limit', help='The number of secrets per page.')]	The number of secrets per page.	None
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/secret/list.py

def list_secrets_command(
    ctx: typer.Context,
    owner: Annotated[str | None, typer.Option("--owner", help=OWNER_SCOPE_HELP)] = None,
    repository: Annotated[str | None, typer.Option("--repository", help=REPOSITORY_SCOPE_HELP)] = None,
    page: Annotated[int | None, typer.Option("--page", help="The page number for pagination.")] = None,
    limit: Annotated[int | None, typer.Option("--limit", help="The number of secrets per page.")] = None,
    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:
    """List the Actions secrets of a repository or an organization.

    Args:
        ctx: The Typer context.
        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.
        page: The page number for pagination.
        limit: The number of secrets per page.
        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]]:
        """List the secrets.

        Returns:
            A tuple containing the secrets as a list - this endpoint answers
            with a bare array rather than with a `total_count` object - and metadata.

        """
        with reporting_scope_errors(COMMAND_NAME), Gitea(token=token, base_url=base_url) as client:
            return client.actions.list_secrets(
                owner=owner,
                repository=repository,
                page=page,
                limit=limit,
            )

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