mirror of
https://github.com/renovatebot/renovate.git
synced 2025-03-16 17:13:37 +00:00
docs: Updated README with a full revamp (#31614)
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com> Co-authored-by: Rhys Arkins <rhys@arkins.net>
This commit is contained in:
Justin Clareburt
GitHub
parent
206a5bde21
commit
839ade15af
1 changed files with 84 additions and 99 deletions
183
readme.md
183
readme.md
|
|
@ -1,10 +1,5 @@
|
||||||
|
|
||||||
|
|
||||||
# Renovate
|
|
||||||
|
|
||||||
Automated dependency updates.
|
|
||||||
Multi-platform and multi-language.
|
|
||||||
|
|
||||||
[](https://raw.githubusercontent.com/renovatebot/renovate/main/license)
|
[](https://raw.githubusercontent.com/renovatebot/renovate/main/license)
|
||||||
[](https://codecov.io/gh/renovatebot/renovate)
|
[](https://codecov.io/gh/renovatebot/renovate)
|
||||||
[](https://renovatebot.com/)
|
[](https://renovatebot.com/)
|
||||||
|
|
@ -12,140 +7,130 @@ Multi-platform and multi-language.
|
||||||
|
|
||||||
[](https://securityscorecards.dev/viewer/?uri=github.com/renovatebot/renovate)
|
[](https://securityscorecards.dev/viewer/?uri=github.com/renovatebot/renovate)
|
||||||
|
|
||||||
## Why Use Renovate?
|
# What is the Mend Renovate CLI?
|
||||||
|
|
||||||
- Get automated Pull Requests to update your dependencies
|
Renovate is an automated dependency update tool.
|
||||||
- Reduce noise by running Renovate on a schedule, for example:
|
It helps to update dependencies in your code without needing to do it manually.
|
||||||
- on weekends
|
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.
|
||||||
- outside of working hours
|
|
||||||
- each week
|
|
||||||
- each month
|
|
||||||
- Relevant package files are discovered automatically
|
|
||||||
- Supports monorepo architectures with workspaces with no extra configuration
|
|
||||||
- Bot behavior is customizable via configuration files (config as code)
|
|
||||||
- Use ESLint-like shared config presets for ease of use and simplifying configuration (JSON format only)
|
|
||||||
- Lock files are supported and updated in the same commit, including immediately resolving conflicts whenever PRs are merged
|
|
||||||
- Get replacement PRs to migrate from a deprecated dependency to the community suggested replacement, works with _most_ managers, see [issue 14149](https://github.com/renovatebot/renovate/issues/14149) for exceptions
|
|
||||||
- Open source (installable via npm/Yarn or Docker Hub) so can be self-hosted or used via the Mend Renovate App
|
|
||||||
|
|
||||||
## Supported Platforms
|
## Features
|
||||||
|
|
||||||
Renovate works on these platforms:
|
- Delivers update PRs directly to your repo
|
||||||
|
- Relevant package files are discovered automatically
|
||||||
|
- Pull Requests automatically generated in your repo
|
||||||
|
- Provides useful information to help you decide which updates to accept (age, adoption, pass rates, merge confidence)
|
||||||
|
- Highly configurable and flexible to fit in with your needs and repository standards
|
||||||
|
- Largest collection of languages and platforms (listed below)
|
||||||
|
- Connects with private repositories and package registries
|
||||||
|
|
||||||
- [GitHub (.com and Enterprise Server)](https://docs.renovatebot.com/modules/platform/github/)
|
### Languages
|
||||||
- [GitLab (.com and CE/EE)](https://docs.renovatebot.com/modules/platform/gitlab/)
|
|
||||||
- [Bitbucket Cloud](https://docs.renovatebot.com/modules/platform/bitbucket/)
|
|
||||||
- [Bitbucket Server](https://docs.renovatebot.com/modules/platform/bitbucket-server/)
|
|
||||||
- [Azure DevOps](https://docs.renovatebot.com/modules/platform/azure/)
|
|
||||||
- [AWS CodeCommit](https://docs.renovatebot.com/modules/platform/codecommit/)
|
|
||||||
- [Gitea and Forgejo](https://docs.renovatebot.com/modules/platform/gitea/)
|
|
||||||
- [Gerrit (experimental)](https://docs.renovatebot.com/modules/platform/gerrit/)
|
|
||||||
|
|
||||||
## Who Uses Renovate?
|
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](https://docs.renovatebot.com/modules/manager/).
|
||||||
|
|
||||||
Renovate is widely used in the developer community:
|
### Platforms
|
||||||
|
|
||||||
|
Renovate updates code repositories on the following platforms: GitHub, GitLab, Bitbucket, Azure DevOps, AWS Code Commit, Gitea, Forgejo, Gerrit (experimental)
|
||||||
|
|
||||||
<details>
|
## Ways to run Renovate
|
||||||
<summary>List of companies and projects that use Renovate</summary>
|
|
||||||
|
|
||||||
- Prisma
|
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.
|
||||||
- Netlify
|
Mend offers cloud-hosted and self-hosted solutions.
|
||||||
- Envoy
|
See the options below.
|
||||||
- Condé Nast
|
|
||||||
- Microsoft
|
|
||||||
- Atlassian
|
|
||||||
- Sourcegraph
|
|
||||||
- Mozilla
|
|
||||||
- Deloitte
|
|
||||||
- Telus
|
|
||||||
- Yarn
|
|
||||||
- HashiCorp
|
|
||||||
- Automattic
|
|
||||||
- Algolia
|
|
||||||
- eBay
|
|
||||||
- Cypress
|
|
||||||
- Red Hat
|
|
||||||
- Financial Times
|
|
||||||
- Uber
|
|
||||||
- Buildkite
|
|
||||||
|
|
||||||
</details>
|
### Mend Renovate Community (Cloud-Hosted)
|
||||||
|
|
||||||
## Renovate OSS Insights
|
**Supports: GitHub.com, Bitbucket Cloud**
|
||||||
|
|
||||||
Renovate is built on a big community and actively invites and supports contributions.
|
Hosted by Mend.io.
|
||||||
Information about our contributors and community can be found on [OSS Insight](https://ossinsight.io/analyze/renovatebot/renovate).
|
No setup is needed.
|
||||||
|
Community plan available (Free)
|
||||||
|
|
||||||
## Star History
|
- GitHub Cloud: Install the [Renovate Cloud-Hosted App](https://github.com/apps/renovate) on your GitHub org, then select the repos to enable
|
||||||
|
- Bitbucket Cloud: Add the [Mend App](https://marketplace.atlassian.com/apps/1232072/mend) to your Workspace, then add the Mend Renovate user to the projects you want to enable
|
||||||
|
|
||||||
[](https://star-history.com/#renovatebot/renovate&Date)
|
### Mend Renovate Community (Self-hosted)
|
||||||
|
|
||||||
## The Renovate Approach
|
**Supports: GitHub, GitLab, Bitbucket Data Center**
|
||||||
|
|
||||||
We believe everyone benefits from automation, whether it's a little or a lot.
|
Install and run your own Renovate server.
|
||||||
This means that Renovate:
|
Access internal packages.
|
||||||
|
|
||||||
- Adapts to your workflow
|
- [Mend Renovate Community Self-Hosted](https://github.com/mend/renovate-ce-ee/tree/main/docs) (Free)
|
||||||
- Allows you to configure its behavior
|
- [Mend Renovate Enterprise](https://www.mend.io/mend-renovate/) (Paid plan)
|
||||||
- Will autodetect settings where possible
|
|
||||||
|
|
||||||
## Using Renovate
|
### Other ways to run Renovate
|
||||||
|
|
||||||
Get started with Renovate by checking out our [tutorial](https://github.com/renovatebot/tutorial).
|
If you can’t use a pre-built job scheduling system, or want to build your own, the following options are available:
|
||||||
|
|
||||||
### GitHub
|
#### Run Renovate on your Pipeline
|
||||||
|
|
||||||
We recommend that you use the Mend Renovate App.
|
Mend provides a _**GitHub Action**_ or a _**GitLab Runner**_ to help you run Renovate as a CI pipeline job.
|
||||||
Install [the Mend Renovate App](https://github.com/apps/renovate) now.
|
|
||||||
[More details on the Mend Renovate App installation](https://docs.renovatebot.com/getting-started/installing-onboarding/).
|
|
||||||
|
|
||||||
### Azure DevOps
|
- GitHub Action: [renovatebot/github-action](https://github.com/renovatebot/github-action).
|
||||||
|
- GitLab Runner: [Renovate Runner project](https://gitlab.com/renovate-bot/renovate-runner/)
|
||||||
|
- AzureDevOps action: [Renovate Me extension](https://marketplace.visualstudio.com/items?itemName=jyc.vsts-extensions-renovate-me)<br>
|
||||||
|
_Note: This extension is created and maintained personally by a Renovate developer/user. Support requests for the extension will not be answered directly in the main Renovate repository._
|
||||||
|
- Custom pipeline: You can create a custom pipeline with a **yml** definition that triggers **npx renovate**. [More details on how to configure the pipeline](https://docs.renovatebot.com/modules/platform/azure/).
|
||||||
|
|
||||||
There are two ways to run Renovate on Azure DevOps:
|
#### Run Renovate CLI
|
||||||
|
|
||||||
- Renovate Me extension
|
There are several ways to run the Renovate CLI directly.
|
||||||
- Custom pipeline
|
See docs: [Running Renovate](https://docs.renovatebot.com/getting-started/running/) for all options.
|
||||||
|
|
||||||
#### Renovate Me extension
|
**Supports: all platforms**
|
||||||
|
|
||||||
Go to the Visual Studio Marketplace and install the [Renovate Me](https://marketplace.visualstudio.com/items?itemName=jyc.vsts-extensions-renovate-me) extension in your organization.
|
## Docs
|
||||||
From there you can create a pipeline with the `RenovateMe` task.
|
|
||||||
|
|
||||||
> [!NOTE]
|
### More about Renovate
|
||||||
> This extension is created and maintained personally by a Renovate developer/user so support requests relating to the extension itself cannot be answered directly in the main Renovate repository.
|
|
||||||
|
|
||||||
#### Custom pipeline
|
- Renovate basics
|
||||||
|
- [Why use Renovate](https://docs.renovatebot.com/#why-use-renovate)
|
||||||
|
- [What does it do? / How does it work?](https://docs.renovatebot.com/key-concepts/how-renovate-works/)
|
||||||
|
- [Who is using it?](https://docs.renovatebot.com/#who-uses-renovate)
|
||||||
|
- Supported platforms and languages
|
||||||
|
- [Supported platforms](https://docs.renovatebot.com/#supported-platforms)
|
||||||
|
- [Supported languages / package managers](https://docs.renovatebot.com/modules/manager/)
|
||||||
|
- Advanced Renovate usage
|
||||||
|
- [Accessing private packages](https://docs.renovatebot.com/getting-started/private-packages/)
|
||||||
|
- [Merge Confidence data](https://docs.renovatebot.com/merge-confidence/)
|
||||||
|
|
||||||
You can create a custom pipeline with a `yml` definition that triggers `npx renovate`.
|
### Renovate Docs
|
||||||
[More details on how to configure the pipeline](https://docs.renovatebot.com/modules/platform/azure/).
|
|
||||||
|
|
||||||
### Bitbucket Cloud/Server, Forgejo, Gitea, GitLab
|
- [Renovate Configuration](https://docs.renovatebot.com/configuration-options/)
|
||||||
|
- [Mend Renovate Self-Hosted Docs](https://github.com/mend/renovate-ce-ee/tree/main/docs)
|
||||||
|
|
||||||
For Bitbucket Cloud, Bitbucket Server, Forgejo, Gitea and GitLab, use our self-hosting option.
|
### Comparisons
|
||||||
|
|
||||||
## Configuration
|
- [Different ways to run Renovate](https://www.mend.io/renovate/)
|
||||||
|
- [Renovate vs Dependabot](https://docs.renovatebot.com/bot-comparison/)
|
||||||
|
|
||||||
Go to our [documentation website](https://docs.renovatebot.com/) to learn how to configure Renovate.
|
## Get involved
|
||||||
We have a [full list of configuration options](https://docs.renovatebot.com/configuration-options/).
|
|
||||||
|
|
||||||
To get help with your configuration, go to the [discussions tab in the Renovate repository](https://github.com/renovatebot/renovate/discussions) and open a new "config help" discussion post.
|
### Issues and Discussions
|
||||||
|
|
||||||
## Self-Hosting
|
Please open a Discussion to get help, suggest a new feature, or to report a bug.
|
||||||
|
We only want maintainers to open Issues.
|
||||||
|
|
||||||
To run your own instance of Renovate you have several options:
|
- [GitHub Discussions for Renovate](https://github.com/renovatebot/renovate/discussions)
|
||||||
|
|
||||||
- Install the `renovate` CLI tool from npmjs, run it on a schedule (e.g. using `cron`)
|
### Contributing
|
||||||
- Run the `renovate/renovate:full` Docker Hub image (same content/versions as the CLI tool), run it on a schedule
|
|
||||||
- Run the `renovate/renovate:latest` Docker Hub image if you only use package managers that don't need third-party binaries (e.g. JavaScript, Docker, NuGet, pip)
|
|
||||||
|
|
||||||
[More details on the self-hosting development](https://github.com/renovatebot/renovate/blob/main/docs/usage/getting-started/running.md).
|
To contribute to Renovate, or run a local copy, please read the contributing guidelines.
|
||||||
|
|
||||||
## Contributing
|
- [Guidelines for Contributing](https://github.com/renovatebot/renovate/blob/main/.github/contributing.md)
|
||||||
|
- Items that need contribution: [good first issues](https://github.com/renovatebot/renovate/contribute)
|
||||||
|
|
||||||
If you want to contribute to Renovate or get a local copy running, please read the instructions in [contributing guidelines](.github/contributing.md).
|
### Contact and Social Media
|
||||||
To get started look at the [list of good first issues](https://github.com/renovatebot/renovate/contribute).
|
|
||||||
|
The Renovate project is proudly supported and actively maintained by Mend.io.
|
||||||
|
|
||||||
|
- Contact [Mend.io](https://www.mend.io/) for commercial support questions.
|
||||||
|
|
||||||
|
Follow us on:
|
||||||
|
|
||||||
|
- Twitter: [x.com/mend_io](https://x.com/mend_io)
|
||||||
|
- LinkedIn: [linkedin.com/company/mend-io](https://linkedin.com/company/mend-io)
|
||||||
|
|
||||||
## Security / Disclosure
|
## Security / Disclosure
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue