Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 1,000,000+ packages pre-installed, including @yolkai/rush-auto-update with all npm packages installed. Try it out:

var rushAutoUpdate = require("@yolkai/rush-auto-update")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

@yolkai/rush-auto-update v2.1.2

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


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

oclif Version Downloads/week

* [rush-auto-update](#rush-auto-update) * [Overview](#overview) * [Setup](#setup) * [Usage](#usage) * [Commands](#commands)


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.


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


  1. Create a GitHub access token with push access to your repository and make it available to your CI's environment as GH_TOKEN.
  2. 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.


```sh-session $ 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 ... ```


* [`rush-auto-update help [COMMAND]`](#rush-auto-update-help-command) * [`rush-auto-update update`](#rush-auto-update-update) * [`rush-auto-update upload`](#rush-auto-update-upload)

rush-auto-update help [COMMAND]

display help for rush-auto-update

  $ rush-auto-update help [COMMAND]

  COMMAND  command to show help for

  --all  see all commands in CLI

See code: @oclif/plugin-help

rush-auto-update update

update Rush's lockfile

  $ rush-auto-update update

See code: src/commands/update.ts

rush-auto-update upload

commit and push the updated lockfile

  $ rush-auto-update upload

See code: src/commands/upload.ts

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free