actions/npm-publish/README.md

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	""

Outputs

name	description
registry-url	Registry URL for publishing.
scope	Package scope to use.
package-version	The version to publish.
npm_token	NPM token.

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: ""