README.md

Rush Install Action

---

Used to better manage rush inside a workflow. Manages caching of packages to ensure speedy execution.

Usage

Pre-requisites

---

This action requires rush version 5.47.0 or newer.

Inputs

---

package-manager

Specifies the package manager used by your rush repository. Valid values are:

• pnpm (default)
• npm
• yarn

build

If set to true will run rush build if rush install completes successfully. The defult value is false

`working-directory

Optional parameter to specify the root directory relative to the root of the repository where rush is installed. The default value is .

NOTE: No prefixing with ./ is required.

Example

---

Below example will work with pnpm as the default package manager and will additionally run rush build.

# .github/workflows/rush.yml
name: Rush Install

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout Code
        uses: actions/checkout@v2

      - name: Rush Install
        uses: advancedcsg-open/actions-rush
        with:
          build: true

License

actions-rush is licensed under the MIT License. See the LICENSE file for more info.