This page was generated based on Github’s Documentation. See our welcome page for context and details.

Github Event `milestone` #

Github Action Trigger #

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`milestone`	- `created` - `closed` - `opened` - `edited` - `deleted`	Last commit on default branch	Default branch

Note: More than one activity type triggers this event. For information about each activity type, see “Webhook events and payloads.” By default, all activity types trigger workflows that run on this event. You can limit your workflow runs to specific activity types using the types keyword. For more information, see “Workflow syntax for GitHub Actions.”

Note: This event will only trigger a workflow run if the workflow file is on the default branch.

Runs your workflow when a milestone in the workflow’s repository is created or modified. For more information about milestones, see “About milestones.” For information about the milestone APIs, see “Objects” in the GraphQL API documentation or “REST API endpoints for issues.”

If you want to run your workflow when an issue is added to or removed from a milestone, use the milestoned or demilestoned activity types for the issues event instead.

For example, you can run a workflow when a milestone has been opened or deleted.

on:
  milestone:
    types: [opened, deleted]

Event Payload #

source

Activities: closed, created, deleted, edited, opened

Common Fields #

These fields are common to every event types available with this trigger.

field	type	required	description
`github.event.enterprise`	object	optional	An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured on an enterprise account or an organization that’s part of an enterprise account. For more information, see “About enterprise accounts."
`github.event.installation`	object	optional	The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."
`github.event.milestone`	object	required	A collection of related issues and pull requests.
`github.event.milestone.closed_at`	string or null	required
`github.event.milestone.closed_issues`	integer	required
`github.event.milestone.created_at`	string	required
`github.event.milestone.creator`	object or null	required
`github.event.milestone.creator.avatar_url`	string	optional
`github.event.milestone.creator.deleted`	boolean	optional
`github.event.milestone.creator.email`	string or null	optional
`github.event.milestone.creator.events_url`	string	optional
`github.event.milestone.creator.followers_url`	string	optional
`github.event.milestone.creator.following_url`	string	optional
`github.event.milestone.creator.gists_url`	string	optional
`github.event.milestone.creator.gravatar_id`	string	optional
`github.event.milestone.creator.html_url`	string	optional
`github.event.milestone.creator.id`	integer	required
`github.event.milestone.creator.login`	string	required
`github.event.milestone.creator.name`	string	optional
`github.event.milestone.creator.node_id`	string	optional
`github.event.milestone.creator.organizations_url`	string	optional
`github.event.milestone.creator.received_events_url`	string	optional
`github.event.milestone.creator.repos_url`	string	optional
`github.event.milestone.creator.site_admin`	boolean	optional
`github.event.milestone.creator.starred_url`	string	optional
`github.event.milestone.creator.subscriptions_url`	string	optional
`github.event.milestone.creator.url`	string	optional
`github.event.milestone.description`	string or null	required
`github.event.milestone.due_on`	string or null	required
`github.event.milestone.html_url`	string	required
`github.event.milestone.id`	integer	required
`github.event.milestone.labels_url`	string	required
`github.event.milestone.node_id`	string	required
`github.event.milestone.number`	integer	required	The number of the milestone.
`github.event.milestone.open_issues`	integer	required
`github.event.milestone.state`	`open`, `closed`	required	The state of the milestone.
`github.event.milestone.title`	string	required	The title of the milestone.
`github.event.milestone.updated_at`	string	required
`github.event.milestone.url`	string	required
`github.event.organization`	object	optional	A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.
`github.event.repository`	object	required	The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository.
`github.event.sender`	object	required	The GitHub user that triggered the event. This property is included in every webhook payload.

`closed` #

This event occurs when there is activity relating to milestones. For more information, see "About milestones." For information about the APIs to manage milestones, see the GraphQL documentation or "Milestones" in the REST API documentation.

If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the milestoned or demilestoned action type for the issues or pull_request events instead.