Files
actions/npm-publish/README.md
Ismo Vuorinen 7061aafd35 chore: add tests, update docs and actions (#299)
* docs: update documentation

* feat: validate-inputs has it's own pyproject

* security: mask DOCKERHUB_PASSWORD

* chore: add tokens, checkout, recrete docs, integration tests

* fix: add `statuses: write` permission to pr-lint
2025-10-18 13:09:19 +03:00

1.9 KiB

ivuorinen/actions/npm-publish

Publish to NPM

Description

Publishes the package to the NPM registry with configurable scope and registry URL.

Inputs

name description required default
registry-url

Registry URL for publishing.

false https://registry.npmjs.org/
scope

Package scope to use.

false @ivuorinen
package-version

The version to publish.

false ${{ github.event.release.tag_name }}
npm_token

NPM token.

true ""
token

GitHub token for authentication

false ""

Outputs

name description
registry-url

Registry URL for publishing.

scope

Package scope to use.

package-version

The version to publish.

Runs

This action is a composite action.

Usage

- uses: ivuorinen/actions/npm-publish@main
  with:
    registry-url:
    # Registry URL for publishing.
    #
    # Required: false
    # Default: https://registry.npmjs.org/

    scope:
    # Package scope to use.
    #
    # Required: false
    # Default: @ivuorinen

    package-version:
    # The version to publish.
    #
    # Required: false
    # Default: ${{ github.event.release.tag_name }}

    npm_token:
    # NPM token.
    #
    # Required: true
    # Default: ""

    token:
    # GitHub token for authentication
    #
    # Required: false
    # Default: ""