shared-actions/pnpm-build/README.md

30 lines
No EOL
1.1 KiB
Markdown

# pnpm-build
Action for building and validating with PNPM.
## Inputs
| Input | Required | Default | Description |
|-------|----------|---------|-------------|
| `working-directory` | No | `.` | Directory containing `package.json` |
| `node-version` | No | `24` | Node.js version |
| `pnpm-version` | No | `10.33` | pnpm version |
| `jfrog-token` | No | `""` | JFrog npm auth token for the Artifactory registry |
| `run-scripts` | No | `ci,typecheck,build` | Comma-separated list of `pnpm run` scripts to execute |
| `frozen-lockfile` | No | `true` | Pass `--frozen-lockfile` to `pnpm install` |
| `check-dedupe` | No | `true` | Run `pnpm dedupe --check` before install |
## Usage
```yaml
- uses: https://schmalz-git.git.onstackit.cloud/schmalz/shared-actions/pnpm-build@pnpm-build-v1
with:
working-directory: frontend
jfrog-token: ${{ secrets.JFROG_TOKEN }}
```
## Notes
- Configures the Artifactory npm registry authentication only if `jfrog-token` is provided.
- Runs `pnpm dedupe --check` before install when `check-dedupe` is `true`.
- Executes each script in `run-scripts` in order via `pnpm run`.