renovate/renovate
1
0
Fork 0
mirror of https://github.com/renovatebot/renovate.git synced 2025-01-10 22:16:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5
Home of the Renovate CLI: Cross-platform Dependency Automation by Mend.io
204 commits 19 branches 9354 tags 235 MiB
TypeScript 95.2%
Go 1.6%
HTML 1.5%
HCL 0.3%
Clojure 0.3%
Other 0.8%
Find a file
Rhys Arkins aa4164b89e Add renovate.json support 
Closes #42
2017-01-18 19:55:03 +01:00
bin/heroku Modify heroku web server to redirect to app logs 2017-01-16 10:45:37 +01:00
docs Add renovate.json support 2017-01-18 19:55:03 +01:00
lib Add renovate.json support 2017-01-18 19:55:03 +01:00
test Refactor templates to use handlebars (#57) 2017-01-18 01:48:17 +01:00
.editorconfig Add editorconfig 2017-01-15 17:23:34 +01:00
.eslintrc.js Use Winston for logging 2017-01-11 10:05:42 +01:00
.gitattributes Add .gitattributes 2017-01-15 17:25:51 +01:00
.gitignore Major refactor to add npm tests (#24) 2017-01-12 17:04:25 +01:00
.npmignore Update npmignore 2017-01-15 17:34:00 +01:00
circle.yml Add codecov to circleCI (#49) 2017-01-15 21:51:35 +01:00
license Add license file 2017-01-15 17:27:41 +01:00
package.json 6.0.2 2017-01-18 14:14:35 +01:00
Procfile Add web server for Heroku 2017-01-16 10:35:03 +01:00
readme.md Configurable ignore behaviour (#56) 2017-01-17 14:27:48 +01:00
renovate.js Add renovate.js to root 2017-01-15 15:05:25 +01:00

readme.md

renovate

Keep npm dependencies up-to-date

Why

  • Creates or updates Pull Requests for each dependency that needs updating
  • Discovers and processes all package.json files in repository (supports monorepo architecture)
  • Supports multiple major versions per-dependency at once
  • Configurable via file, environment, CLI, and package.json
  • Self-hosted

Inspired by the services at Greenkeeper and Doppins.

Install

$ npm install -g renovate

Authentication

You need to select a GitHub user for renovate to assume the identity of. It's recommended that you use a dedicated "bot" account for this to avoid user confusion.

The script will need a GitHub Personal Access Token with "repo" permissions. You can find instructions for generating it here: https://help.github.com/articles/creating-an-access-token-for-command-line-use/

This token needs to be configured via file, environment variable, or CLI. See docs/configuration.md for details. The simplest way is to expose it as GITHUB_TOKEN.

Usage (CLI)

$ node renovate --help

  Usage: renovate [options] [repositories...]

  Options:

    -h, --help                               output usage information
    -t, --token <token>                      GitHub Auth Token
    -p, --package-files <list>               List of package.json file names
    -d, --dep-types <list>                   List of dependency types
    -i, --ignore-deps <list>                 List of dependencies to ignore
    -b, --labels <list>                      List of labels to apply
    -r, --ignore-future [true/false]         Ignore versions tagged as "future"
    -r, --ignore-unstable [true/false]       Ignore versions with unstable semver
    -r, --respect-latest [true/false]        Ignore versions newer than dependency's "latest"
    -r, --recreate-closed [true/false]       Recreate PR even if same was previously closed
    -r, --recreate-unmergeable [true/false]  Recreate PR if existing branch is unmergeable
    -l, --log-level <level>                  Log Level

  Examples:

    $ renovate --token abc123 singapore/lint-condo
    $ renovate --ignore-unstable=false -l verbose singapore/lint-condo
    $ renovate singapore/lint-condo singapore/package-test

Deployment

See deployment docs for details.

Design Decisions

See design decisions doc for details.