action-setup/README.md

65 lines
1.0 KiB
Markdown
Raw Normal View History

2020-05-08 15:44:30 +08:00
# Setup PNPM
Install PNPM package manager.
## Inputs
### `version`
**Required** Version of PNPM to install.
### `dest`
**Optional** Where to store PNPM files.
### `bin_dest`
**Optional** Where to store executables (`pnpm` and `pnpx` commands).
### `registry`
2020-05-10 13:00:23 +08:00
**Optional** (_default:_ `https://registry.npmjs.com`) Registry to download PNPM from.
2020-05-08 15:44:30 +08:00
2020-05-09 20:13:46 +08:00
### `run_install`
2020-05-10 13:00:23 +08:00
**Optional** (_default:_ `null`) If specified, run `pnpm install`.
2020-05-09 20:13:46 +08:00
2020-05-08 15:44:30 +08:00
## Outputs
### `dest`
Expanded path of inputs#dest.
### `bin_dest`
2020-05-08 22:23:23 +08:00
Expanded path of inputs#bin_dest.
2020-05-08 15:44:30 +08:00
## Usage example
```yaml
on:
- push
- pull_request
jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
2020-05-08 22:18:35 +08:00
- uses: pnpm/action-setup@v1.1.0
2020-05-08 15:44:30 +08:00
with:
version: 4.11.1
- name: Install dependencies
run: pnpm install
```
## Notes
2020-05-08 15:57:48 +08:00
This action does not setup Node.js for you, use [actions/setup-node](https://github.com/actions/setup-node) yourself.
2020-05-08 15:44:30 +08:00
## License
[MIT](https://git.io/JfclH) © [Hoàng Văn Khải](https://github.com/KSXGitHub/)