Skip to content

README.md

Latest commit

 

History

History
170 lines (123 loc) · 8.36 KB

README.md

File metadata and controls

170 lines (123 loc) · 8.36 KB

Icon GitHub Action: Package

Package

Overview

Action to create and upload an npm package tarball from a Node.js project.

Usage

- uses: hoverkraft-tech/ci-github-nodejs/actions/package@c9d9d041ba4ef35695ee469c4782fa6a8bbebbcc # 0.21.2
  with:
    # Working directory where the package is packed.
    # Can be absolute or relative to the repository root.
    #
    # Default: `.`
    working-directory: .

    # Optional build artifact ID to download before packaging.
    build-artifact-id: ""

    # Optional version to apply with `npm version` before packaging.
    # The version is applied without creating a git tag.
    version: ""

    # Name of the uploaded package tarball artifact
    # Default: `package-tarball`
    artifact-name: package-tarball

Inputs

Input Description Required Default
working-directory Working directory where the package is packed. false .
Can be absolute or relative to the repository root.
build-artifact-id Optional build artifact ID to download before packaging. false -
When provided, the artifact will be downloaded to the workspace.
version Optional version to apply with npm version before packaging. false -
The version is applied without creating a Git tag.
artifact-name Name of the uploaded package tarball artifact false package-tarball

Outputs

Output Description
package-tarball-path Absolute path to the generated package tarball
package-tarball-artifact-id Artifact ID of the uploaded package tarball

Contributing

Contributions are welcome! Please see the contributing guidelines for more details.

Marketplace Release License Stars PRs Welcome

Overview

Action to create and upload an npm package tarball from a Node.js project

Usage

- uses: hoverkraft-tech/ci-github-nodejs/actions/package@775ce0902c528062cc94141dd7d13261083b752a # 0.22.0
  with:
    # Working directory where the package is packed.
    # Can be absolute or relative to the repository root.
    #
    # Default: `.`
    working-directory: .

    # Optional build artifact ID to download before packaging.
    # When provided, the artifact will be downloaded to the workspace.
    build-artifact-id: ""

    # Optional path to the build artifact contents relative to the workspace root.
    # Used to locate the files to be included in the package when a build artifact is downloaded.
    #
    # Default: `${{ github.workspace }}`
    build-artifact-path: ${{ github.workspace }}

    # Optional version to apply with `npm version` before packaging.
    # The version is applied without creating a Git tag.
    version: ""

    # Name of the uploaded package tarball artifact
    # Default: `package-tarball`
    artifact-name: package-tarball

Inputs

Input Description Required Default
working-directory Working directory where the package is packed. false .
Can be absolute or relative to the repository root.
build-artifact-id Optional build artifact ID to download before packaging. false -
When provided, the artifact will be downloaded to the workspace.
build-artifact-path Optional path to the build artifact contents relative to the workspace root. false ${{ github.workspace }}
Used to locate the files to be included in the package when a build artifact is downloaded.
version Optional version to apply with npm version before packaging. false -
The version is applied without creating a Git tag.
artifact-name Name of the uploaded package tarball artifact false package-tarball

Outputs

Output Description
package-tarball-path Absolute path to the generated package tarball
package-tarball-artifact-id Artifact ID of the uploaded package tarball

Contributing

Contributions are welcome! Please see the contributing guidelines for more details.

License

This project is licensed under the MIT License.

SPDX-License-Identifier: MIT

Copyright © 2026 hoverkraft

For more details, see the license.

This documentation was automatically generated by CI Dokumentor.