registry_package

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

Github Event registry_package #

Github Action Trigger #

source

Webhook event payloadActivity typesGITHUB_SHAGITHUB_REF
registry_packagepublished
updated
Commit of the published packageBranch or tag of the published package

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.

Note: When pushing multi-architecture container images, this event occurs once per manifest, so you might observe your workflow triggering multiple times. To mitigate this, and only run your workflow job for the event that contains the actual image tag information, use a conditional:

jobs:
    job_name:
        if: ${{ github.event.registry_package.package_version.container_metadata.tag.name != '' }}

Runs your workflow when activity related to GitHub Packages occurs in your repository. For more information, see “GitHub Packages Documentation.”

For example, you can run a workflow when a new package version has been published.

on:
  registry_package:
    types: [published]

Event Payload #

source

Activities: published, updated

Common Fields #

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

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.installationobjectoptional

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.organizationobjectoptional

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.registry_packageobjectrequired
github.event.registry_package.ecosystemstringrequired
github.event.registry_package.html_urlstringrequired
github.event.registry_package.idintegerrequired
github.event.registry_package.namestringrequired
github.event.registry_package.namespacestringrequired
github.event.registry_package.ownerobjectrequired
github.event.registry_package.owner.avatar_urlstringrequired
github.event.registry_package.owner.events_urlstringrequired
github.event.registry_package.owner.followers_urlstringrequired
github.event.registry_package.owner.following_urlstringrequired
github.event.registry_package.owner.gists_urlstringrequired
github.event.registry_package.owner.gravatar_idstringrequired
github.event.registry_package.owner.html_urlstringrequired
github.event.registry_package.owner.idintegerrequired
github.event.registry_package.owner.loginstringrequired
github.event.registry_package.owner.node_idstringrequired
github.event.registry_package.owner.organizations_urlstringrequired
github.event.registry_package.owner.received_events_urlstringrequired
github.event.registry_package.owner.repos_urlstringrequired
github.event.registry_package.owner.site_adminbooleanrequired
github.event.registry_package.owner.starred_urlstringrequired
github.event.registry_package.owner.subscriptions_urlstringrequired
github.event.registry_package.owner.typestringrequired
github.event.registry_package.owner.urlstringrequired
github.event.registry_package.package_typestringrequired
github.event.registry_package.package_version.author.avatar_urlstringrequired
github.event.registry_package.package_version.author.events_urlstringrequired
github.event.registry_package.package_version.author.followers_urlstringrequired
github.event.registry_package.package_version.author.following_urlstringrequired
github.event.registry_package.package_version.author.gists_urlstringrequired
github.event.registry_package.package_version.author.gravatar_idstringrequired
github.event.registry_package.package_version.author.html_urlstringrequired
github.event.registry_package.package_version.author.idintegerrequired
github.event.registry_package.package_version.author.loginstringrequired
github.event.registry_package.package_version.author.node_idstringrequired
github.event.registry_package.package_version.author.organizations_urlstringrequired
github.event.registry_package.package_version.author.received_events_urlstringrequired
github.event.registry_package.package_version.author.repos_urlstringrequired
github.event.registry_package.package_version.author.site_adminbooleanrequired
github.event.registry_package.package_version.author.starred_urlstringrequired
github.event.registry_package.package_version.author.subscriptions_urlstringrequired
github.event.registry_package.package_version.author.typestringrequired
github.event.registry_package.package_version.author.urlstringrequired
github.event.registry_package.package_version.descriptionstringrequired
github.event.registry_package.package_version.draftbooleanoptional
github.event.registry_package.package_version.html_urlstringrequired
github.event.registry_package.package_version.idintegerrequired
github.event.registry_package.package_version.installation_commandstringrequired
github.event.registry_package.package_version.manifeststringoptional
github.event.registry_package.package_version.metadataarray of objectsrequired
github.event.registry_package.package_version.namestringrequired
github.event.registry_package.package_version.package_filesarray of objectsrequired
github.event.registry_package.package_version.package_urlstringrequired
github.event.registry_package.package_version.prereleasebooleanoptional
github.event.registry_package.package_version.releaseobjectoptional
github.event.registry_package.package_version.rubygems_metadataarray of objectsoptional
github.event.registry_package.package_version.rubygems_metadata.namestringoptional
github.event.registry_package.package_version.rubygems_metadata.descriptionstringoptional
github.event.registry_package.package_version.rubygems_metadata.readmestringoptional
github.event.registry_package.package_version.rubygems_metadata.homepagestringoptional
github.event.registry_package.package_version.rubygems_metadata.version_infoobjectoptional
github.event.registry_package.package_version.rubygems_metadata.version_info.versionstringoptional
github.event.registry_package.package_version.rubygems_metadata.platformstringoptional
github.event.registry_package.package_version.rubygems_metadata.metadataobjectoptional
github.event.registry_package.package_version.rubygems_metadata.repostringoptional
github.event.registry_package.package_version.rubygems_metadata.dependenciesarray of objectsoptional
github.event.registry_package.package_version.rubygems_metadata.commit_oidstringoptional
github.event.registry_package.package_version.summarystringrequired
github.event.registry_package.package_version.tag_namestringoptional
github.event.registry_package.package_version.versionstringrequired
github.event.registry_package.registryobject or nullrequired
github.event.repositoryobjectoptional

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.senderobjectrequired

The GitHub user that triggered the event. This property is included in every webhook payload.

published #

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

To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission.

Note: GitHub recommends that you use the newer package event instead.

fieldtyperequireddescription
github.event.actionpublishedrequired
github.event.registry_package.created_atstring or nullrequired
github.event.registry_package.descriptionstring or nullrequired
github.event.registry_package.package_versionobject or nullrequired
github.event.registry_package.package_version.authorobjectoptional
github.event.registry_package.package_version.bodystring or objectoptional
github.event.registry_package.package_version.body_htmlstringoptional
github.event.registry_package.package_version.container_metadataobjectoptional
github.event.registry_package.package_version.container_metadata.labelsobject or nulloptional
github.event.registry_package.package_version.container_metadata.manifestobject or nulloptional
github.event.registry_package.package_version.container_metadata.tagobjectoptional
github.event.registry_package.package_version.container_metadata.tag.digeststringoptional
github.event.registry_package.package_version.container_metadata.tag.namestringoptional
github.event.registry_package.package_version.created_atstringoptional
github.event.registry_package.package_version.docker_metadataarray of objectsoptional
github.event.registry_package.package_version.docker_metadata.tagsarray of stringsoptional
github.event.registry_package.package_version.npm_metadataobject or nulloptional
github.event.registry_package.package_version.npm_metadata.namestringoptional
github.event.registry_package.package_version.npm_metadata.versionstringoptional
github.event.registry_package.package_version.npm_metadata.npm_userstringoptional
github.event.registry_package.package_version.npm_metadata.authornull or string or objectoptional
github.event.registry_package.package_version.npm_metadata.bugsnull or string or objectoptional
github.event.registry_package.package_version.npm_metadata.dependenciesobjectoptional
github.event.registry_package.package_version.npm_metadata.dev_dependenciesobjectoptional
github.event.registry_package.package_version.npm_metadata.peer_dependenciesobjectoptional
github.event.registry_package.package_version.npm_metadata.optional_dependenciesobjectoptional
github.event.registry_package.package_version.npm_metadata.descriptionstringoptional
github.event.registry_package.package_version.npm_metadata.distnull or string or objectoptional
github.event.registry_package.package_version.npm_metadata.git_headstringoptional
github.event.registry_package.package_version.npm_metadata.homepagestringoptional
github.event.registry_package.package_version.npm_metadata.licensestringoptional
github.event.registry_package.package_version.npm_metadata.mainstringoptional
github.event.registry_package.package_version.npm_metadata.repositorynull or string or objectoptional
github.event.registry_package.package_version.npm_metadata.scriptsobjectoptional
github.event.registry_package.package_version.npm_metadata.idstringoptional
github.event.registry_package.package_version.npm_metadata.node_versionstringoptional
github.event.registry_package.package_version.npm_metadata.npm_versionstringoptional
github.event.registry_package.package_version.npm_metadata.has_shrinkwrapbooleanoptional
github.event.registry_package.package_version.npm_metadata.maintainersarray of stringsoptional
github.event.registry_package.package_version.npm_metadata.contributorsarray of stringsoptional
github.event.registry_package.package_version.npm_metadata.enginesobjectoptional
github.event.registry_package.package_version.npm_metadata.keywordsarray of stringsoptional
github.event.registry_package.package_version.npm_metadata.filesarray of stringsoptional
github.event.registry_package.package_version.npm_metadata.binobjectoptional
github.event.registry_package.package_version.npm_metadata.manobjectoptional
github.event.registry_package.package_version.npm_metadata.directoriesnull or string or objectoptional
github.event.registry_package.package_version.npm_metadata.osarray of stringsoptional
github.event.registry_package.package_version.npm_metadata.cpuarray of stringsoptional
github.event.registry_package.package_version.npm_metadata.readmestringoptional
github.event.registry_package.package_version.npm_metadata.installation_commandstringoptional
github.event.registry_package.package_version.npm_metadata.release_idintegeroptional
github.event.registry_package.package_version.npm_metadata.commit_oidstringoptional
github.event.registry_package.package_version.npm_metadata.published_via_actionsbooleanoptional
github.event.registry_package.package_version.npm_metadata.deleted_by_idintegeroptional
github.event.registry_package.package_version.nuget_metadataarray of objects or nulloptional
github.event.registry_package.package_version.nuget_metadata.idnull or string or object or integeroptional
github.event.registry_package.package_version.nuget_metadata.namestringoptional
github.event.registry_package.package_version.nuget_metadata.valueboolean or string or integer or objectoptional
github.event.registry_package.package_version.package_files.content_typestringrequired
github.event.registry_package.package_version.package_files.created_atstringrequired
github.event.registry_package.package_version.package_files.download_urlstringrequired
github.event.registry_package.package_version.package_files.idintegerrequired
github.event.registry_package.package_version.package_files.md5string or nullrequired
github.event.registry_package.package_version.package_files.namestringrequired
github.event.registry_package.package_version.package_files.sha1string or nullrequired
github.event.registry_package.package_version.package_files.sha256string or nullrequired
github.event.registry_package.package_version.package_files.sizeintegerrequired
github.event.registry_package.package_version.package_files.statestring or nullrequired
github.event.registry_package.package_version.package_files.updated_atstringrequired
github.event.registry_package.package_version.release.authorobjectoptional
github.event.registry_package.package_version.release.author.avatar_urlstringoptional
github.event.registry_package.package_version.release.author.events_urlstringoptional
github.event.registry_package.package_version.release.author.followers_urlstringoptional
github.event.registry_package.package_version.release.author.following_urlstringoptional
github.event.registry_package.package_version.release.author.gists_urlstringoptional
github.event.registry_package.package_version.release.author.gravatar_idstringoptional
github.event.registry_package.package_version.release.author.html_urlstringoptional
github.event.registry_package.package_version.release.author.idintegeroptional
github.event.registry_package.package_version.release.author.loginstringoptional
github.event.registry_package.package_version.release.author.node_idstringoptional
github.event.registry_package.package_version.release.author.organizations_urlstringoptional
github.event.registry_package.package_version.release.author.received_events_urlstringoptional
github.event.registry_package.package_version.release.author.repos_urlstringoptional
github.event.registry_package.package_version.release.author.site_adminbooleanoptional
github.event.registry_package.package_version.release.author.starred_urlstringoptional
github.event.registry_package.package_version.release.author.subscriptions_urlstringoptional
github.event.registry_package.package_version.release.author.typestringoptional
github.event.registry_package.package_version.release.author.urlstringoptional
github.event.registry_package.package_version.release.created_atstringoptional
github.event.registry_package.package_version.release.draftbooleanoptional
github.event.registry_package.package_version.release.html_urlstringoptional
github.event.registry_package.package_version.release.idintegeroptional
github.event.registry_package.package_version.release.namestring or nulloptional
github.event.registry_package.package_version.release.prereleasebooleanoptional
github.event.registry_package.package_version.release.published_atstringoptional
github.event.registry_package.package_version.release.tag_namestringoptional
github.event.registry_package.package_version.release.target_commitishstringoptional
github.event.registry_package.package_version.release.urlstringoptional
github.event.registry_package.package_version.target_commitishstringoptional
github.event.registry_package.package_version.target_oidstringoptional
github.event.registry_package.package_version.updated_atstringoptional
github.event.registry_package.registry.about_urlstringoptional
github.event.registry_package.registry.namestringoptional
github.event.registry_package.registry.typestringoptional
github.event.registry_package.registry.urlstringoptional
github.event.registry_package.registry.vendorstringoptional
github.event.registry_package.updated_atstring or nullrequired

updated #

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

To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission.

Note: GitHub recommends that you use the newer package event instead.

fieldtyperequireddescription
github.event.actionupdatedrequired
github.event.registry_package.created_atstringrequired
github.event.registry_package.descriptionnullrequired
github.event.registry_package.package_versionobjectrequired
github.event.registry_package.package_version.authorobjectrequired
github.event.registry_package.package_version.bodystringrequired
github.event.registry_package.package_version.body_htmlstringrequired
github.event.registry_package.package_version.created_atstringrequired
github.event.registry_package.package_version.docker_metadataarray of object,nullsoptional
github.event.registry_package.package_version.package_files.content_typestringoptional
github.event.registry_package.package_version.package_files.created_atstringoptional
github.event.registry_package.package_version.package_files.download_urlstringoptional
github.event.registry_package.package_version.package_files.idintegeroptional
github.event.registry_package.package_version.package_files.md5string or nulloptional
github.event.registry_package.package_version.package_files.namestringoptional
github.event.registry_package.package_version.package_files.sha1string or nulloptional
github.event.registry_package.package_version.package_files.sha256stringoptional
github.event.registry_package.package_version.package_files.sizeintegeroptional
github.event.registry_package.package_version.package_files.statestringoptional
github.event.registry_package.package_version.package_files.updated_atstringoptional
github.event.registry_package.package_version.release.authorobjectrequired
github.event.registry_package.package_version.release.author.avatar_urlstringrequired
github.event.registry_package.package_version.release.author.events_urlstringrequired
github.event.registry_package.package_version.release.author.followers_urlstringrequired
github.event.registry_package.package_version.release.author.following_urlstringrequired
github.event.registry_package.package_version.release.author.gists_urlstringrequired
github.event.registry_package.package_version.release.author.gravatar_idstringrequired
github.event.registry_package.package_version.release.author.html_urlstringrequired
github.event.registry_package.package_version.release.author.idintegerrequired
github.event.registry_package.package_version.release.author.loginstringrequired
github.event.registry_package.package_version.release.author.node_idstringrequired
github.event.registry_package.package_version.release.author.organizations_urlstringrequired
github.event.registry_package.package_version.release.author.received_events_urlstringrequired
github.event.registry_package.package_version.release.author.repos_urlstringrequired
github.event.registry_package.package_version.release.author.site_adminbooleanrequired
github.event.registry_package.package_version.release.author.starred_urlstringrequired
github.event.registry_package.package_version.release.author.subscriptions_urlstringrequired
github.event.registry_package.package_version.release.author.typestringrequired
github.event.registry_package.package_version.release.author.urlstringrequired
github.event.registry_package.package_version.release.created_atstringrequired
github.event.registry_package.package_version.release.draftbooleanrequired
github.event.registry_package.package_version.release.html_urlstringrequired
github.event.registry_package.package_version.release.idintegerrequired
github.event.registry_package.package_version.release.namestringrequired
github.event.registry_package.package_version.release.prereleasebooleanrequired
github.event.registry_package.package_version.release.published_atstringrequired
github.event.registry_package.package_version.release.tag_namestringrequired
github.event.registry_package.package_version.release.target_commitishstringrequired
github.event.registry_package.package_version.release.urlstringrequired
github.event.registry_package.package_version.target_commitishstringrequired
github.event.registry_package.package_version.target_oidstringrequired
github.event.registry_package.package_version.updated_atstringrequired
github.event.registry_package.updated_atstringrequired