renovate README

The project's README from github.com/renovatebot/renovate. As one markdown file: README.md.

Mend Renovate CLI banner

License: AGPL-3.0-only codecov Renovate enabled Build status Docker Pulls OpenSSF Scorecard

What is the Mend Renovate CLI?

Renovate is an automated dependency update tool. It helps to update dependencies in your code without needing to do it manually. When Renovate runs on your repo, it looks for references to dependencies (both public and private) and, if there are newer versions available, Renovate can create pull requests to update your versions automatically.

Features

Languages

Renovate can provide updates for most popular languages, platforms, and registries including: npm, Java, Python, .NET, Scala, Ruby, Go, Docker and more. Supports over 90 different package managers.

Platforms

Renovate updates code repositories on the following platforms: GitHub, GitLab, Bitbucket, Azure DevOps, AWS Code Commit (experimental), Gitea, Forgejo, Gerrit (experimental), SCM-Manager (experimental)

Ways to run Renovate

The most effective way to run Renovate is to use an automated job scheduling system that regularly runs Renovate on all enabled repositories and responds with priority to user activity. Mend offers cloud-hosted and self-hosted solutions. See the options below.

Mend Renovate Community (Cloud-Hosted)

Supports: GitHub.com, Bitbucket Cloud

Hosted by Mend.io. No setup is needed. Community plan available (Free)

Mend Renovate Community (Self-hosted)

Supports: GitHub, GitLab, Bitbucket Data Center

Install and run your own Renovate server. Access internal packages.

Other ways to run Renovate

If you can’t use a pre-built job scheduling system, or want to build your own, the following options are available:

Run Renovate on your Pipeline

Mend provides a GitHub Action or a GitLab Runner to help you run Renovate as a CI pipeline job.

Run Renovate CLI

There are several ways to run the Renovate CLI directly. See docs: Running Renovate for all options.

Supports: all platforms

For additional community-maintained options, see the Community Tools page.

Docs

More about Renovate

Renovate Docs

Comparisons

Get involved

Issues and Discussions

Please open a Discussion to get help, suggest a new feature, or to report a bug. We only want maintainers to open Issues.

Contributing

To contribute to Renovate, or run a local copy, please read the contributing guidelines.

Contact and Social Media

The Renovate project is proudly supported and actively maintained by Mend.io.

Follow us on:

Security / Disclosure

If you find any bug with Renovate that may be a security problem, please report it through the GitHub Security Advisories process. This way we can evaluate the bug and hopefully fix it before it gets abused. Please give us enough time to investigate the bug before you report it anywhere else.

If you would like to discuss a potential finding before raising the Advisory, then e-mail us at: [email protected].

renovate (renovatebot/renovate)

Searching Database…

22.8K ·GitHub
What is this?Renovate is an automated dependency update tool: it scans your repo for dependency references and opens pull requests when newer versions are available, so you don't update them by hand.
Is it a hosted service, or do I run it myself?Both. It's a CLI tool you can run yourself, Mend hosts it as a cloud app for GitHub.com and Bitbucket Cloud, and it can also run as a CI job via a GitHub Action or GitLab Runner.
How do I get it updating my repos?Easiest path: install the Renovate Cloud-Hosted App on your GitHub org and select the repos to enable. Alternatives: the GitHub Action or GitLab Runner in CI, or a custom pipeline that runs npx renovate.
What do I need before it can run?The cloud app needs no setup at all. The CLI and CI options run via npx renovate on Node and need access to your git platform and package registries, private ones included.
Is support equally solid on all those platforms?No — AWS Code Commit, Gerrit and SCM-Manager are experimental, and the Azure DevOps 'Renovate Me' extension is community-maintained, so its support requests aren't handled in the main Renovate repo.
Which code platforms does it work with?GitHub, GitLab, Bitbucket, Azure DevOps, Gitea and Forgejo, plus experimental support for AWS Code Commit, Gerrit and SCM-Manager. The CLI itself runs on all platforms.
Can I host it on my own server?Yes. Mend Renovate Community Self-Hosted is free to install on your own server and can reach internal packages; Enterprise is the paid plan for the self-hosted route.
Will it be reading my private repos?Yes — it looks for dependency references in both public and private repos and connects to private package registries, so it needs read access to your code.
Is it only for npm and JavaScript projects?No — it covers most popular ecosystems, including npm, Java, Python, .NET, Scala, Ruby, Go and Docker, with support for over 90 package managers.
Do I have to point it at my dependency files?No — Renovate discovers the relevant package files in your repo automatically and delivers the update PRs straight to the repo.
How does it help me decide which updates to accept?Each PR comes with Merge Confidence signals — the update's age, adoption and pass rates — so you can judge how safe an update is before merging it.
Size
162.1 MB
Stars
22.8K
Age
9y
Commits · 90 Days