Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dafnik/setup-node-pnpm
Setup node, pnpm and caching
https://github.com/dafnik/setup-node-pnpm
ci dependencies
Last synced: 27 days ago
JSON representation
Setup node, pnpm and caching
- Host: GitHub
- URL: https://github.com/dafnik/setup-node-pnpm
- Owner: Dafnik
- License: mit
- Created: 2023-04-10T16:07:45.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-07-22T08:12:47.000Z (5 months ago)
- Last Synced: 2024-11-24T19:49:34.140Z (30 days ago)
- Topics: ci, dependencies
- Homepage:
- Size: 85.9 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# setup-node-pnpm
A composite Action for setting up Node and PNPM.
## Usage
```yml
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout your repository using git
uses: actions/checkout@v3
- name: setup node and pnpm
uses: dafnik/setup-node-pnpm@v3
# with:
# pnpm: 8
# node: 22
# node-file: ''
# cwd: '.'
# install: false
# install-ignore-scripts: false
```
| Inputs | Default value | Description |
|--------------------------|---------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `pnpm` | `9` | PNPM version to install |
| `node` | `22` | Version Spec of the version to use in SemVer notation.
It also emits such aliases as lts, latest, nightly and canary builds.
Examples: 12.x, 10.15.1, >=10.15.0, lts/Hydrogen, 16-nightly, latest, node |
| `node-file` | `''` | File containing the version Spec of the version to use.
Examples: .nvmrc, .node-version, .tool-versions.
If `node` and `node-file` are both provided the action will use version from `node-file`. |
| `cwd` | `.` | Changes pnpm-lock.yaml lookup location and the work directory of "pnpm install" if enabled |
| `install` | `false` | Runs "pnpm install" in working directory |
| `install-ignore-scripts` | `false` | Runs "pnpm install --ignore-scripts" in working directory. Enable "install" or "install-ignore-scripts" only once |
Furthermore, see [action.yml](action.yml)
## Testing
Local testing is done with [act][act]
Run the test workflow:
```bash
act -j test
```
## Release instructions
In order to release a new version of this action:
1. Locate the semantic version of the [upcoming release][release-list] (a draft is maintained by the [`draft-release` workflow][draft-release]).
2. Publish the draft release from the `main` branch with semantic version as the tag name, _with_ the checkbox to publish to the GitHub Marketplace checked. :ballot_box_with_check:
3. After publishing the release, the [`release` workflow][release] will automatically run to create/update the corresponding the major version tag such as `v0`.
⚠️ Environment approval is required. Check the [Release workflow run list][release-workflow-runs].
## License
The scripts and documentation in this project are released under the [MIT License](LICENSE).
[act]: https://github.com/nektos/act
[release-list]: https://github.com/dafnik/setup-node-pnpm/releases
[draft-release]: .github/workflows/draft-release.yml
[release]: .github/workflows/release.yml
[release-workflow-runs]: https://github.com/dafnik/setup-node-pnpm/actions/workflows/release.yml