Skip to content

Ambiguous example for registry_package workflow trigger #17905

Closed
@driimus

Description

@driimus

Code of Conduct

What article on docs.github.com is affected?

From https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#registry_package

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

could be updated to something more descriptive, such as:

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

It would also be helpful to further elaborate how the action types are triggered here:

What part(s) of the article would you like to see updated?

Given the description for action types of a registry_package event:

`action`|`string` | The action that was performed. Can be `published` or `updated`.

And the following example:

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

I would've expected published to act as a trigger for a new npm registry package being created. The use case being running a script only once in a package monorepo for any newly created package.

Instead, the published action is dispatched whenever a new version of a package is published, which includes the behavior I would've expected for updated.

At this time I haven't been able to trigger updated actions to understand what differentiates it or what scenarios it supports. Perhaps another section of the docs that could be expanded.

Additional information

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    actionsThis issue or pull request should be reviewed by the docs actions teamcontentThis issue or pull request belongs to the Docs Content teamhelp wantedAnyone is welcome to open a pull request to fix this issue

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions