Home of the Renovate CLI: Cross-platform Dependency Automation by Mend.io
Find a file
Rhys Arkins e9ee8002df fix: revert docker/meteor onboarding code (#916)
* Revert "feat: support docker and meteor onboarding without npm"

This reverts commit 437145b901.

# Conflicts:
#	test/workers/repository/onboarding.spec.js

* chore: downgrade npm cache message from debug to trace
2017-10-11 19:25:25 +02:00
bin feat: use yarn as a dependency (#806) 2017-09-14 17:57:17 +02:00
docs fix: add commitMessage for pin groups (#910) 2017-10-11 13:10:12 +02:00
lib fix: revert docker/meteor onboarding code (#916) 2017-10-11 19:25:25 +02:00
test fix: revert docker/meteor onboarding code (#916) 2017-10-11 19:25:25 +02:00
.editorconfig Add editorconfig 2017-01-15 17:23:34 +01:00
.eslintignore chore: fix eslint (#793) 2017-09-13 21:43:52 +02:00
.eslintrc.js refactor: use prettier instead of eslint-plugin-prettier (#864) 2017-10-01 07:06:06 +02:00
.gitattributes Add .gitattributes 2017-01-15 17:25:51 +01:00
.gitignore chore: re-enable jest cache (#400) 2017-06-30 16:02:40 +02:00
.prettierignore refactor: use prettier instead of eslint-plugin-prettier (#864) 2017-10-01 07:06:06 +02:00
circle.yml fix: update circleci to use node 8 (#870) 2017-10-01 16:04:40 +02:00
contributing.md chore: update contributing.md (#895) 2017-10-06 12:21:26 +02:00
license Add license file 2017-01-15 17:27:41 +01:00
package.json fix(deps): update dependency jsonwebtoken to v8.1.0 (#903) 2017-10-11 14:28:41 +02:00
Procfile Replace npm run/test with yarn run/test (#182) 2017-04-21 09:46:41 +02:00
readme.md docs: add link to config-help in readme 2017-10-08 09:12:16 +02:00
yarn.lock fix(deps): update dependency jsonwebtoken to v8.1.0 (#903) 2017-10-11 14:28:41 +02:00

Renovate banner

renovate

Keep dependencies up-to-date.

GitHub license codecov Join the chat at https://gitter.im/renovate-app/Lobby David Renovate enabled

Why

  • Creates or updates Pull Requests for each dependency that needs updating
  • Discovers and processes all package.json files in repository (supports monorepo architecture including yarn workspaces)
  • Supports multiple major versions per-dependency at once
  • Configurable via file, environment, CLI, and package.json
  • Supports eslint-like preset configs for ease of use
  • Updates yarn.lock and package-lock.json files natively
  • Supports GitHub and GitLab
  • Open source and can be self-hosted or used via GitHub App

Configuration Help

If you would like help on your Renovate configuration, or simply get someone to review it, we have created a config-help repository https://github.com/renovateapp/config-help/issues where you can post an issue with your config.

GitHub App

Renovate is now available as a free GitHub "App". Go to https://github.com/apps/renovate to enable it now.

Install

$ npm install -g renovate

Authentication

You need to select a repository user for renovate to assume the identity of, and generate a Personal Access Token. It's strongly recommended that you use a dedicated "bot" account for this to avoid user confusion and to avoid the Renovate bot mistaking changes you have made or PRs you have raised for its own.

You can find instructions for GitHub here (select "repo" permissions)

You can find instructions for GitLab here.

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 or GITLAB_TOKEN.

Usage

Run renovate --help for usage details.

Note: The first time you run renovate on a repository, it will not upgrade any dependencies. Instead, it will create a Pull Request (Merge Request if GitLab) called 'Configure Renovate' and commit a default renovate.json file to the repository. This PR can be close unmerged if the default settings are fine for you. Also, this behaviour can be disabled if you set the onboarding configuration option to false before running.

Deployment

See deployment docs for details.

Configuration

The Configuration and Configuration FAQ documents should be helpful.

You can also raise an issue in https://github.com/renovateapp/config-help if you'd like to get your config reviewed or ask any questions.

Design Decisions

See design decisions doc for details.