This page was generated based on Github’s Documentation. See our welcome page for context and details.
Github Event registry_package
#
Github Action Trigger #
Webhook event payload | Activity types | GITHUB_SHA | GITHUB_REF |
---|---|---|---|
registry_package | - published - updated | Commit of the published package | Branch 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 #
Activities: published
, updated
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 |
github.event.installation | object | optional | The GitHub App installation. Webhook payloads contain the |
github.event.organization | object | optional | A GitHub organization. Webhook payloads contain the |
github.event.registry_package | object | required | |
github.event.registry_package.ecosystem | string | required | |
github.event.registry_package.html_url | string | required | |
github.event.registry_package.id | integer | required | |
github.event.registry_package.name | string | required | |
github.event.registry_package.namespace | string | required | |
github.event.registry_package.owner | object | required | |
github.event.registry_package.owner.avatar_url | string | required | |
github.event.registry_package.owner.events_url | string | required | |
github.event.registry_package.owner.followers_url | string | required | |
github.event.registry_package.owner.following_url | string | required | |
github.event.registry_package.owner.gists_url | string | required | |
github.event.registry_package.owner.gravatar_id | string | required | |
github.event.registry_package.owner.html_url | string | required | |
github.event.registry_package.owner.id | integer | required | |
github.event.registry_package.owner.login | string | required | |
github.event.registry_package.owner.node_id | string | required | |
github.event.registry_package.owner.organizations_url | string | required | |
github.event.registry_package.owner.received_events_url | string | required | |
github.event.registry_package.owner.repos_url | string | required | |
github.event.registry_package.owner.site_admin | boolean | required | |
github.event.registry_package.owner.starred_url | string | required | |
github.event.registry_package.owner.subscriptions_url | string | required | |
github.event.registry_package.owner.type | string | required | |
github.event.registry_package.owner.url | string | required | |
github.event.registry_package.package_type | string | required | |
github.event.registry_package.package_version.author.avatar_url | string | required | |
github.event.registry_package.package_version.author.events_url | string | required | |
github.event.registry_package.package_version.author.followers_url | string | required | |
github.event.registry_package.package_version.author.following_url | string | required | |
github.event.registry_package.package_version.author.gists_url | string | required | |
github.event.registry_package.package_version.author.gravatar_id | string | required | |
github.event.registry_package.package_version.author.html_url | string | required | |
github.event.registry_package.package_version.author.id | integer | required | |
github.event.registry_package.package_version.author.login | string | required | |
github.event.registry_package.package_version.author.node_id | string | required | |
github.event.registry_package.package_version.author.organizations_url | string | required | |
github.event.registry_package.package_version.author.received_events_url | string | required | |
github.event.registry_package.package_version.author.repos_url | string | required | |
github.event.registry_package.package_version.author.site_admin | boolean | required | |
github.event.registry_package.package_version.author.starred_url | string | required | |
github.event.registry_package.package_version.author.subscriptions_url | string | required | |
github.event.registry_package.package_version.author.type | string | required | |
github.event.registry_package.package_version.author.url | string | required | |
github.event.registry_package.package_version.description | string | required | |
github.event.registry_package.package_version.draft | boolean | optional | |
github.event.registry_package.package_version.html_url | string | required | |
github.event.registry_package.package_version.id | integer | required | |
github.event.registry_package.package_version.installation_command | string | required | |
github.event.registry_package.package_version.manifest | string | optional | |
github.event.registry_package.package_version.metadata | array of objects | required | |
github.event.registry_package.package_version.name | string | required | |
github.event.registry_package.package_version.package_files | array of objects | required | |
github.event.registry_package.package_version.package_url | string | required | |
github.event.registry_package.package_version.prerelease | boolean | optional | |
github.event.registry_package.package_version.release | object | optional | |
github.event.registry_package.package_version.rubygems_metadata | array of objects | optional | |
github.event.registry_package.package_version.rubygems_metadata.name | string | optional | |
github.event.registry_package.package_version.rubygems_metadata.description | string | optional | |
github.event.registry_package.package_version.rubygems_metadata.readme | string | optional | |
github.event.registry_package.package_version.rubygems_metadata.homepage | string | optional | |
github.event.registry_package.package_version.rubygems_metadata.version_info | object | optional | |
github.event.registry_package.package_version.rubygems_metadata.version_info.version | string | optional | |
github.event.registry_package.package_version.rubygems_metadata.platform | string | optional | |
github.event.registry_package.package_version.rubygems_metadata.metadata | object | optional | |
github.event.registry_package.package_version.rubygems_metadata.repo | string | optional | |
github.event.registry_package.package_version.rubygems_metadata.dependencies | array of objects | optional | |
github.event.registry_package.package_version.rubygems_metadata.commit_oid | string | optional | |
github.event.registry_package.package_version.summary | string | required | |
github.event.registry_package.package_version.tag_name | string | optional | |
github.event.registry_package.package_version.version | string | required | |
github.event.registry_package.registry | object or null | required | |
github.event.repository | object | optional | The repository on GitHub where the event occurred. Webhook payloads contain the |
github.event.sender | object | required | 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.
field | type | required | description |
---|---|---|---|
github.event.action | published | required | |
github.event.registry_package.created_at | string or null | required | |
github.event.registry_package.description | string or null | required | |
github.event.registry_package.package_version | object or null | required | |
github.event.registry_package.package_version.author | object | optional | |
github.event.registry_package.package_version.body | string or object | optional | |
github.event.registry_package.package_version.body_html | string | optional | |
github.event.registry_package.package_version.container_metadata | object | optional | |
github.event.registry_package.package_version.container_metadata.labels | object or null | optional | |
github.event.registry_package.package_version.container_metadata.manifest | object or null | optional | |
github.event.registry_package.package_version.container_metadata.tag | object | optional | |
github.event.registry_package.package_version.container_metadata.tag.digest | string | optional | |
github.event.registry_package.package_version.container_metadata.tag.name | string | optional | |
github.event.registry_package.package_version.created_at | string | optional | |
github.event.registry_package.package_version.docker_metadata | array of objects | optional | |
github.event.registry_package.package_version.docker_metadata.tags | array of strings | optional | |
github.event.registry_package.package_version.npm_metadata | object or null | optional | |
github.event.registry_package.package_version.npm_metadata.name | string | optional | |
github.event.registry_package.package_version.npm_metadata.version | string | optional | |
github.event.registry_package.package_version.npm_metadata.npm_user | string | optional | |
github.event.registry_package.package_version.npm_metadata.author | null or string or object | optional | |
github.event.registry_package.package_version.npm_metadata.bugs | null or string or object | optional | |
github.event.registry_package.package_version.npm_metadata.dependencies | object | optional | |
github.event.registry_package.package_version.npm_metadata.dev_dependencies | object | optional | |
github.event.registry_package.package_version.npm_metadata.peer_dependencies | object | optional | |
github.event.registry_package.package_version.npm_metadata.optional_dependencies | object | optional | |
github.event.registry_package.package_version.npm_metadata.description | string | optional | |
github.event.registry_package.package_version.npm_metadata.dist | null or string or object | optional | |
github.event.registry_package.package_version.npm_metadata.git_head | string | optional | |
github.event.registry_package.package_version.npm_metadata.homepage | string | optional | |
github.event.registry_package.package_version.npm_metadata.license | string | optional | |
github.event.registry_package.package_version.npm_metadata.main | string | optional | |
github.event.registry_package.package_version.npm_metadata.repository | null or string or object | optional | |
github.event.registry_package.package_version.npm_metadata.scripts | object | optional | |
github.event.registry_package.package_version.npm_metadata.id | string | optional | |
github.event.registry_package.package_version.npm_metadata.node_version | string | optional | |
github.event.registry_package.package_version.npm_metadata.npm_version | string | optional | |
github.event.registry_package.package_version.npm_metadata.has_shrinkwrap | boolean | optional | |
github.event.registry_package.package_version.npm_metadata.maintainers | array of strings | optional | |
github.event.registry_package.package_version.npm_metadata.contributors | array of strings | optional | |
github.event.registry_package.package_version.npm_metadata.engines | object | optional | |
github.event.registry_package.package_version.npm_metadata.keywords | array of strings | optional | |
github.event.registry_package.package_version.npm_metadata.files | array of strings | optional | |
github.event.registry_package.package_version.npm_metadata.bin | object | optional | |
github.event.registry_package.package_version.npm_metadata.man | object | optional | |
github.event.registry_package.package_version.npm_metadata.directories | null or string or object | optional | |
github.event.registry_package.package_version.npm_metadata.os | array of strings | optional | |
github.event.registry_package.package_version.npm_metadata.cpu | array of strings | optional | |
github.event.registry_package.package_version.npm_metadata.readme | string | optional | |
github.event.registry_package.package_version.npm_metadata.installation_command | string | optional | |
github.event.registry_package.package_version.npm_metadata.release_id | integer | optional | |
github.event.registry_package.package_version.npm_metadata.commit_oid | string | optional | |
github.event.registry_package.package_version.npm_metadata.published_via_actions | boolean | optional | |
github.event.registry_package.package_version.npm_metadata.deleted_by_id | integer | optional | |
github.event.registry_package.package_version.nuget_metadata | array of objects or null | optional | |
github.event.registry_package.package_version.nuget_metadata.id | null or string or object or integer | optional | |
github.event.registry_package.package_version.nuget_metadata.name | string | optional | |
github.event.registry_package.package_version.nuget_metadata.value | boolean or string or integer or object | optional | |
github.event.registry_package.package_version.package_files.content_type | string | required | |
github.event.registry_package.package_version.package_files.created_at | string | required | |
github.event.registry_package.package_version.package_files.download_url | string | required | |
github.event.registry_package.package_version.package_files.id | integer | required | |
github.event.registry_package.package_version.package_files.md5 | string or null | required | |
github.event.registry_package.package_version.package_files.name | string | required | |
github.event.registry_package.package_version.package_files.sha1 | string or null | required | |
github.event.registry_package.package_version.package_files.sha256 | string or null | required | |
github.event.registry_package.package_version.package_files.size | integer | required | |
github.event.registry_package.package_version.package_files.state | string or null | required | |
github.event.registry_package.package_version.package_files.updated_at | string | required | |
github.event.registry_package.package_version.release.author | object | optional | |
github.event.registry_package.package_version.release.author.avatar_url | string | optional | |
github.event.registry_package.package_version.release.author.events_url | string | optional | |
github.event.registry_package.package_version.release.author.followers_url | string | optional | |
github.event.registry_package.package_version.release.author.following_url | string | optional | |
github.event.registry_package.package_version.release.author.gists_url | string | optional | |
github.event.registry_package.package_version.release.author.gravatar_id | string | optional | |
github.event.registry_package.package_version.release.author.html_url | string | optional | |
github.event.registry_package.package_version.release.author.id | integer | optional | |
github.event.registry_package.package_version.release.author.login | string | optional | |
github.event.registry_package.package_version.release.author.node_id | string | optional | |
github.event.registry_package.package_version.release.author.organizations_url | string | optional | |
github.event.registry_package.package_version.release.author.received_events_url | string | optional | |
github.event.registry_package.package_version.release.author.repos_url | string | optional | |
github.event.registry_package.package_version.release.author.site_admin | boolean | optional | |
github.event.registry_package.package_version.release.author.starred_url | string | optional | |
github.event.registry_package.package_version.release.author.subscriptions_url | string | optional | |
github.event.registry_package.package_version.release.author.type | string | optional | |
github.event.registry_package.package_version.release.author.url | string | optional | |
github.event.registry_package.package_version.release.created_at | string | optional | |
github.event.registry_package.package_version.release.draft | boolean | optional | |
github.event.registry_package.package_version.release.html_url | string | optional | |
github.event.registry_package.package_version.release.id | integer | optional | |
github.event.registry_package.package_version.release.name | string or null | optional | |
github.event.registry_package.package_version.release.prerelease | boolean | optional | |
github.event.registry_package.package_version.release.published_at | string | optional | |
github.event.registry_package.package_version.release.tag_name | string | optional | |
github.event.registry_package.package_version.release.target_commitish | string | optional | |
github.event.registry_package.package_version.release.url | string | optional | |
github.event.registry_package.package_version.target_commitish | string | optional | |
github.event.registry_package.package_version.target_oid | string | optional | |
github.event.registry_package.package_version.updated_at | string | optional | |
github.event.registry_package.registry.about_url | string | optional | |
github.event.registry_package.registry.name | string | optional | |
github.event.registry_package.registry.type | string | optional | |
github.event.registry_package.registry.url | string | optional | |
github.event.registry_package.registry.vendor | string | optional | |
github.event.registry_package.updated_at | string or null | required |
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.
field | type | required | description |
---|---|---|---|
github.event.action | updated | required | |
github.event.registry_package.created_at | string | required | |
github.event.registry_package.description | null | required | |
github.event.registry_package.package_version | object | required | |
github.event.registry_package.package_version.author | object | required | |
github.event.registry_package.package_version.body | string | required | |
github.event.registry_package.package_version.body_html | string | required | |
github.event.registry_package.package_version.created_at | string | required | |
github.event.registry_package.package_version.docker_metadata | array of object,nulls | optional | |
github.event.registry_package.package_version.package_files.content_type | string | optional | |
github.event.registry_package.package_version.package_files.created_at | string | optional | |
github.event.registry_package.package_version.package_files.download_url | string | optional | |
github.event.registry_package.package_version.package_files.id | integer | optional | |
github.event.registry_package.package_version.package_files.md5 | string or null | optional | |
github.event.registry_package.package_version.package_files.name | string | optional | |
github.event.registry_package.package_version.package_files.sha1 | string or null | optional | |
github.event.registry_package.package_version.package_files.sha256 | string | optional | |
github.event.registry_package.package_version.package_files.size | integer | optional | |
github.event.registry_package.package_version.package_files.state | string | optional | |
github.event.registry_package.package_version.package_files.updated_at | string | optional | |
github.event.registry_package.package_version.release.author | object | required | |
github.event.registry_package.package_version.release.author.avatar_url | string | required | |
github.event.registry_package.package_version.release.author.events_url | string | required | |
github.event.registry_package.package_version.release.author.followers_url | string | required | |
github.event.registry_package.package_version.release.author.following_url | string | required | |
github.event.registry_package.package_version.release.author.gists_url | string | required | |
github.event.registry_package.package_version.release.author.gravatar_id | string | required | |
github.event.registry_package.package_version.release.author.html_url | string | required | |
github.event.registry_package.package_version.release.author.id | integer | required | |
github.event.registry_package.package_version.release.author.login | string | required | |
github.event.registry_package.package_version.release.author.node_id | string | required | |
github.event.registry_package.package_version.release.author.organizations_url | string | required | |
github.event.registry_package.package_version.release.author.received_events_url | string | required | |
github.event.registry_package.package_version.release.author.repos_url | string | required | |
github.event.registry_package.package_version.release.author.site_admin | boolean | required | |
github.event.registry_package.package_version.release.author.starred_url | string | required | |
github.event.registry_package.package_version.release.author.subscriptions_url | string | required | |
github.event.registry_package.package_version.release.author.type | string | required | |
github.event.registry_package.package_version.release.author.url | string | required | |
github.event.registry_package.package_version.release.created_at | string | required | |
github.event.registry_package.package_version.release.draft | boolean | required | |
github.event.registry_package.package_version.release.html_url | string | required | |
github.event.registry_package.package_version.release.id | integer | required | |
github.event.registry_package.package_version.release.name | string | required | |
github.event.registry_package.package_version.release.prerelease | boolean | required | |
github.event.registry_package.package_version.release.published_at | string | required | |
github.event.registry_package.package_version.release.tag_name | string | required | |
github.event.registry_package.package_version.release.target_commitish | string | required | |
github.event.registry_package.package_version.release.url | string | required | |
github.event.registry_package.package_version.target_commitish | string | required | |
github.event.registry_package.package_version.target_oid | string | required | |
github.event.registry_package.package_version.updated_at | string | required | |
github.event.registry_package.updated_at | string | required |