Skip to content
package

GitHub Action

Pkg Action

v6.0.0 Latest version

Pkg Action

package

Pkg Action

A GitHub Action for 'compiling' node projects into binaries using vercel/pkg or equivalent

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Pkg Action

              
  uses: lando/[email protected]
Learn more about this action in lando/pkg-action

Choose a version

Pkg Action

This is a GitHub action that allows you to "compile" node projects with @yao-pkg/pkg. It supports:

  • All @yao-pkg/pkg supported node versions
  • x64|amd64 and aarch64|arm64
  • macos|linux|windows.

If you are also looking to code sign/notarize the resulting binaries then check out @lando/code-sign-action.

Caveats

  • If you are looking to "cross compile" binaries across OS AND architecture then we recommend you matrix strategy across this actions os and arch inputs instead of runs-on. This is neccessary because arm64 compilation is currently emulated on Linux only. If you are compiling just on amd64|x64 then it's probably ok to use runs-on.
  • If you are looking to "cross compile" binaries across OS AND architecture AND code sign/notarize the resulting binaries we recommend you first upload the artifacts and then download them to the os you need to do the code signing.

See Advanced Usage below for some examples of ^.

Required Inputs

These keys must be set correctly for the action to work.

Name Description Example Value
entrypoint The binary entrypoint path. bin/entrypoint.js

Optional Inputs

These keys are set to sane defaults but can be modified as needed.

Name Description Default Example
arch The architecture to build for. ${{ runner.arch }} x64 | amd64 | aarch64 | arm64
config The config file to use. package.json config.json
filename The name of the resulting binary. ${{ package.name }} mycli
node-version The node version to package with. 20 8 | 10 | 12 | 14 | 16 | 18 | 20
options Additional options and flags to pass into pkg. null Additional pkg options
os The operating system to build for. ${{ runner.os }} linux | macos | win
pkg The pkg package` to use. @yao-pkg/[email protected] [email protected]
upload Upload the artifacts. Useful if you need to grab them for downstream for things like code signing. true false | true
upload-key Upload key for the artifact. Useful if want to override outputs.artifact-key with a specific value. ${{ github.event.repository.name }}-${{ inputs.node-version }}-${{ inputs.os }}-${{ inputs.arch }}-${{ github.sha }} "my-pkg"

Note that .exe will automatically be appended to all resulting binaries on win. Also note that all binaries will end up in the dist folder.

Outputs

outputs:
  file:
    description: "The path to the generated binary."
    value: ${{ steps.pkg-action.outputs.file }}
  artifact-key:
    description: "The artifact upload key."
    value: ${{ steps.pkg-action.outputs.artifact-key }}

Usage

Basic Usage

name: Package into node binary
uses: lando/pkg-action@v4
with:
  entrypoint: bin/cli

Advanced Usage

ALL OPTIONS

name: Package into node binary
uses: lando/pkg-action@v4
with:
  entrypoint: bin/cli
  arch: arm64
  config: package.json
  node-version: 16
  options: -C
  os: win
  upload: false
  pkg: "@yao-pkg/[email protected]"

CROSS COMPILE ON ALL THE THINGS

runs-on: ubuntu-20.04
strategy:
  matrix:
    arch:
      - x64
      - arm64
    node-version:
      - 20
    os:
      - linux
      - macos
      - win
steps:
  - name: Package into node binary
    uses: lando/pkg-action@v2
    with:
      entrypoint: bin/cli
      filename: mycli
      arch: ${{ matrix.arch }}
      node-version: ${{ matrix.node-version }}
      os: ${{ matrix.os }}

Changelog

We try to log all changes big and small in both THE CHANGELOG and the release notes.

Releasing

Create a release and publish to GitHub Actions Marketplace. Note that the release tag must be a semantic version.

Maintainers

Contributors

Made with contrib.rocks.

Other Resources