Skip to content

Commit

Permalink
Merge pull request #11 from Dafnik/feat/add-inputs-readme
Browse files Browse the repository at this point in the history
docs: add inputs table to README.md
  • Loading branch information
Dafnik committed May 2, 2023
2 parents ea9a147 + 61256d8 commit 7e26388
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 16 deletions.
8 changes: 8 additions & 0 deletions .idea/.gitignore

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

31 changes: 15 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,26 +13,25 @@ jobs:

- name: setup node and pnpm
uses: dafnik/setup-node-pnpm@v1
with:
# PNPM version to install
pnpm: 8

# Node version to install
node: 18

# Changes pnpm-lock.yaml lookup location and the work directory of "pnpm install" if enabled
cwd: "."

# Runs "pnpm install" in working directory
install: false

# Runs "pnpm install --ingore-scripts" in working directory
# Enable "install" or "install-ignore-scripts" only once
# with:
# pnpm: 8
# node: 18
# cwd: "."
# install: false
# install-ignore-scripts: false
```

| Inputs | Default value | Description |
|--------------------------|---------------|-------------------------------------------------------------------------------------------------------------------|
| `pnpm` | `8` | PNPM version to install |
| `node` | `18` | Node version to install |
| `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)


Furthermore, see [action.yml](action.yml)

## Testing

Expand Down

0 comments on commit 7e26388

Please sign in to comment.