diff --git a/README.md b/README.md index c6945e1..203b000 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,7 @@ These keys are set to sane defaults but can be modified as needed. |---|---|---|---| | `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](https://github.com/vercel/pkg#usage) | | `os` | The operating system to build for. | `${{ runner.os }}` | `linux` \| `macos` \| `win` | @@ -38,6 +39,8 @@ These keys are set to sane defaults but can be modified as needed. | `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 ```yaml @@ -71,7 +74,7 @@ with: entrypoint: bin/cli arch: arm64 config: package.json - node-version: 14 + node-version: 16 options: -C os: win upload: false @@ -87,7 +90,7 @@ strategy: - x64 - arm64 node-version: - - 16 + - 20 os: - linux - macos @@ -97,6 +100,7 @@ steps: uses: lando/pkg-action@v2 with: entrypoint: bin/cli + filename: mycli arch: ${{ matrix.arch }} node-version: ${{ matrix.node-version }} os: ${{ matrix.os }}