milestone

Inspect the targeted repository’s milestones (read-only).

Added in version 1.1.0.

Part of the github resource type: all functions operate on the repository the job was dispatched to. The profile parameter defaults to the profile named in the resource declaration.

saltext.github.resources.github.modules.milestone.list_(*, state='open', sort='due_on', direction='asc', per_page=None, fields=None, profile=None)[source]

Return the targeted repository’s milestones.

CLI Example:

salt 'my-org/my-repo' milestone.list
state

Filter milestones by their state. Either open, closed, or all. Default is open.

sort

Field to sort results by. Either due_on or completeness. Default is due_on.

direction

Sort direction. Either asc or desc. Default is asc.

per_page

Pagination size, maximum 100.

fields

Only include these fields in the output. A single field name reduces each entry to the field’s value.

profile

Profile configuration name to use. Defaults to the resource declaration’s profile.

saltext.github.resources.github.modules.milestone.get(number=None, *, name=None, profile=None)[source]

Return information about a single milestone in the targeted repository.

CLI Example:

salt 'my-org/my-repo' milestone.get 72
salt 'my-org/my-repo' milestone.get name=my_milestone
number

Milestone number to retrieve. If provided, overrides name.

name

Title of the milestone to retrieve.

profile

Profile configuration name to use. Defaults to the resource declaration’s profile.