Skip to content

gitea.cli.issue.create

create

Create issues command.

Functions:

gitea.cli.issue.create.create_command 

create_command(
    ctx: Context,
    owner: Annotated[
        str,
        Option("--owner", help="Owner of the repository."),
    ],
    title: Annotated[
        str,
        Option("--title", help="Title of the new issue."),
    ],
    repository: Annotated[
        str | None,
        Option(
            "--repository", help=REPOSITORY_REQUIRED_HELP
        ),
    ] = None,
    assignee: Annotated[
        str | None,
        Option(
            "--assignee",
            help="The username to assign the issue to.",
        ),
    ] = None,
    assignees: Annotated[
        list[str] | None,
        Option(
            "--assignees",
            help="The usernames to assign the issue to.",
        ),
    ] = None,
    body: Annotated[
        str | None,
        Option("--body", help="The body of the new issue."),
    ] = None,
    closed: Annotated[
        bool | None,
        Option(
            "--closed",
            help="Whether the issue is created closed.",
        ),
    ] = None,
    due_date: Annotated[
        datetime | None,
        Option(
            "--due-date",
            help="The due date of the new issue.",
        ),
    ] = None,
    labels: Annotated[
        list[int] | None,
        Option(
            "--labels",
            help="The label IDs to apply to the new issue.",
        ),
    ] = None,
    milestone: Annotated[
        int | None,
        Option(
            "--milestone",
            help="The milestone ID to associate with the new issue.",
        ),
    ] = None,
    ref: Annotated[
        str | None,
        Option(
            "--ref", help="The reference of the new issue."
        ),
    ] = 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

Create a new issue in a repository.

Parameters:

Name Type Description Default
ctx Context

The Typer context.

 required
owner Annotated[str, Option('--owner', help='Owner of the repository.')]

The owner of the repository.

 required
repository Annotated[str | None, Option('--repository', help=REPOSITORY_REQUIRED_HELP)]

The name of the repository, which this command requires.

 None
title Annotated[str, Option('--title', help='Title of the new issue.')]

The title of the new issue.

 required
assignee Annotated[str | None, Option('--assignee', help='The username to assign the issue to.')]

The username to assign the issue to.

 None
assignees Annotated[list[str] | None, Option('--assignees', help='The usernames to assign the issue to.')]

The usernames to assign the issue to.

 None
body Annotated[str | None, Option('--body', help='The body of the new issue.')]

The body of the new issue.

 None
closed Annotated[bool | None, Option('--closed', help='Whether the issue is created closed.')]

Whether the issue is created closed.

 None
due_date Annotated[datetime | None, Option('--due-date', help='The due date of the new issue.')]

The due date of the new issue.

 None
labels Annotated[list[int] | None, Option('--labels', help='The label IDs to apply to the new issue.')]

The label IDs to apply to the new issue.

 None
milestone Annotated[int | None, Option('--milestone', help='The milestone ID to associate with the new issue.')]

The milestone ID to associate with the new issue.

 None
ref Annotated[str | None, Option('--ref', help='The reference of the new issue.')]

The reference of the new issue.

 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/issue/create.py 
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
def create_command(
    ctx: typer.Context,
    owner: Annotated[str, typer.Option("--owner", help="Owner of the repository.")],
    title: Annotated[str, typer.Option("--title", help="Title of the new issue.")],
    repository: Annotated[str | None, typer.Option("--repository", help=REPOSITORY_REQUIRED_HELP)] = None,
    assignee: Annotated[
        str | None,
        typer.Option("--assignee", help="The username to assign the issue to."),
    ] = None,
    assignees: Annotated[
        list[str] | None,
        typer.Option("--assignees", help="The usernames to assign the issue to."),
    ] = None,
    body: Annotated[
        str | None,
        typer.Option("--body", help="The body of the new issue."),
    ] = None,
    closed: Annotated[
        bool | None,
        typer.Option("--closed", help="Whether the issue is created closed."),
    ] = None,
    due_date: Annotated[
        datetime | None,
        typer.Option("--due-date", help="The due date of the new issue."),
    ] = None,
    labels: Annotated[
        list[int] | None,
        typer.Option("--labels", help="The label IDs to apply to the new issue."),
    ] = None,
    milestone: Annotated[
        int | None,
        typer.Option("--milestone", help="The milestone ID to associate with the new issue."),
    ] = None,
    ref: Annotated[
        str | None,
        typer.Option("--ref", help="The reference of the new issue."),
    ] = 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:
    """Create a new issue in a repository.

    Args:
        ctx: The Typer context.
        owner: The owner of the repository.
        repository: The name of the repository, which this command requires.
        title: The title of the new issue.
        assignee: The username to assign the issue to.
        assignees: The usernames to assign the issue to.
        body: The body of the new issue.
        closed: Whether the issue is created closed.
        due_date: The due date of the new issue.
        labels: The label IDs to apply to the new issue.
        milestone: The milestone ID to associate with the new issue.
        ref: The reference of the new issue.
        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 require_repository  # 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]]:
        """Create issue information.

        Returns:
            A tuple containing the issue data and metadata.

        """
        target_repository = require_repository(repository, command="gitea-cli issue create")

        with Gitea(token=token, base_url=base_url) as client:
            return client.issue.create_issue(
                owner=owner,
                repository=target_repository,
                title=title,
                assignee=assignee,
                assignees=assignees,
                body=body,
                closed=closed,
                due_date=due_date,
                labels=labels,
                milestone=milestone,
                ref=ref,
            )

    execute_api_command(api_call=api_call, base_url=base_url, command_name="gitea-cli issue create")