@yolkai/rush-auto-update

rush-auto-update

A tool to automatically update Rush's lockfile, compatible with Renovate.

• rush-auto-update
• Overview
• Setup
• Usage
• Commands

Overview

rush-auto-update provides two commands: update and upload. update updates Rush's lockfile using rush update, and stages the new lockfile with Git. upload commits and pushes the updated lockfile.

When correctly configured with a CI service, rush-auto-update enables your Renovate branches to automatically update with the correct lockfile, similar to greenkeeper-lockfile.

Limitations

rush-auto-update is currently compatible only with Renovate and CircleCI.

Setup

• Create a GitHub access token with push access to your repository and make it available to your CI's environment as GH_TOKEN.
• Configure your CI to run npx @yolkai/rush-auto-update update right before it executes your tests and npx @yolkai/rush-auto-update upload right after it executed your tests.

Usage

$ npm install -g @yolkai/rush-auto-update
$ rush-auto-update COMMAND
running command...
$ rush-auto-update (-v|--version|version)
@yolkai/rush-auto-update/0.0.1-9 darwin-x64 node-v10.13.0
$ rush-auto-update --help [COMMAND]
USAGE
  $ rush-auto-update COMMAND
...

Commands

• rush-auto-update help [COMMAND]
• rush-auto-update update
• rush-auto-update upload

rush-auto-update help [COMMAND]

display help for rush-auto-update

USAGE
  $ rush-auto-update help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

rush-auto-update update

update Rush's lockfile

USAGE
  $ rush-auto-update update

See code: src/commands/update.ts

rush-auto-update upload

commit and push the updated lockfile

USAGE
  $ rush-auto-update upload

See code: src/commands/upload.ts