Skip to content

Commit

Permalink
docs: Updated README with a full revamp (#31614)
Browse files Browse the repository at this point in the history
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
Co-authored-by: Rhys Arkins <rhys@arkins.net>
  • Loading branch information
3 people authored Oct 11, 2024
1 parent 206a5bd commit 839ade1
Showing 1 changed file with 84 additions and 99 deletions.
183 changes: 84 additions & 99 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,151 +1,136 @@
![Mend Renovate CLI banner](https://docs.renovatebot.com/assets/images/mend-renovate-cli-banner.jpg)

# Renovate

Automated dependency updates.
Multi-platform and multi-language.

[![License: AGPL-3.0-only](https://img.shields.io/badge/license-%20%09AGPL--3.0--only-blue.svg)](https://raw.githubusercontent.com/renovatebot/renovate/main/license)
[![codecov](https://codecov.io/gh/renovatebot/renovate/branch/main/graph/badge.svg)](https://codecov.io/gh/renovatebot/renovate)
[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovatebot.com/)
[![Build status](https://github.com/renovatebot/renovate/actions/workflows/build.yml/badge.svg)](https://github.com/renovatebot/renovate/actions/workflows/build.yml)
![Docker Pulls](https://img.shields.io/docker/pulls/renovate/renovate?color=turquoise)
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/renovatebot/renovate/badge)](https://securityscorecards.dev/viewer/?uri=github.com/renovatebot/renovate)

## Why Use Renovate?
# 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

- 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

### Languages

- Get automated Pull Requests to update your dependencies
- Reduce noise by running Renovate on a schedule, for example:
- on weekends
- 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
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/).

## Supported Platforms
### Platforms

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

- [GitHub (.com and Enterprise Server)](https://docs.renovatebot.com/modules/platform/github/)
- [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/)
## Ways to run Renovate

## Who Uses 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.

Renovate is widely used in the developer community:
### Mend Renovate Community (Cloud-Hosted)

![Logos of companies and projects that use Renovate](./docs/usage/assets/images/matrix.png)
**Supports: GitHub.com, Bitbucket Cloud**

<details>
<summary>List of companies and projects that use Renovate</summary>
Hosted by Mend.io.
No setup is needed.
Community plan available (Free)

- Prisma
- Netlify
- Envoy
- Condé Nast
- Microsoft
- Atlassian
- Sourcegraph
- Mozilla
- Deloitte
- Telus
- Yarn
- HashiCorp
- Automattic
- Algolia
- eBay
- Cypress
- Red Hat
- Financial Times
- Uber
- Buildkite
- 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

</details>
### Mend Renovate Community (Self-hosted)

## Renovate OSS Insights
**Supports: GitHub, GitLab, Bitbucket Data Center**

Renovate is built on a big community and actively invites and supports contributions.
Information about our contributors and community can be found on [OSS Insight](https://ossinsight.io/analyze/renovatebot/renovate).
Install and run your own Renovate server.
Access internal packages.

## Star History
- [Mend Renovate Community Self-Hosted](https://github.com/mend/renovate-ce-ee/tree/main/docs) (Free)
- [Mend Renovate Enterprise](https://www.mend.io/mend-renovate/) (Paid plan)

[![Star History Chart](https://api.star-history.com/svg?repos=renovatebot/renovate&type=Date)](https://star-history.com/#renovatebot/renovate&Date)
### Other ways to run Renovate

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

We believe everyone benefits from automation, whether it's a little or a lot.
This means that Renovate:
#### Run Renovate on your Pipeline

- Adapts to your workflow
- Allows you to configure its behavior
- Will autodetect settings where possible
Mend provides a _**GitHub Action**_ or a _**GitLab Runner**_ to help you run Renovate as a CI pipeline job.

## Using Renovate
- 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/).

Get started with Renovate by checking out our [tutorial](https://github.com/renovatebot/tutorial).
#### Run Renovate CLI

### GitHub
There are several ways to run the Renovate CLI directly.
See docs: [Running Renovate](https://docs.renovatebot.com/getting-started/running/) for all options.

We recommend that you use the Mend Renovate App.
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/).
**Supports: all platforms**

### Azure DevOps
## Docs

There are two ways to run Renovate on Azure DevOps:
### More about Renovate

- Renovate Me extension
- 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/)

#### Renovate Me extension
### Renovate Docs

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.
From there you can create a pipeline with the `RenovateMe` task.
- [Renovate Configuration](https://docs.renovatebot.com/configuration-options/)
- [Mend Renovate Self-Hosted Docs](https://github.com/mend/renovate-ce-ee/tree/main/docs)

> [!NOTE]
> 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.
### Comparisons

#### Custom pipeline
- [Different ways to run Renovate](https://www.mend.io/renovate/)
- [Renovate vs Dependabot](https://docs.renovatebot.com/bot-comparison/)

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/).
## Get involved

### Bitbucket Cloud/Server, Forgejo, Gitea, GitLab
### Issues and Discussions

For Bitbucket Cloud, Bitbucket Server, Forgejo, Gitea and GitLab, use our self-hosting option.
Please open a Discussion to get help, suggest a new feature, or to report a bug.
We only want maintainers to open Issues.

## Configuration
- [GitHub Discussions for Renovate](https://github.com/renovatebot/renovate/discussions)

Go to our [documentation website](https://docs.renovatebot.com/) to learn how to configure Renovate.
We have a [full list of configuration options](https://docs.renovatebot.com/configuration-options/).
### Contributing

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.
To contribute to Renovate, or run a local copy, please read the contributing guidelines.

## Self-Hosting
- [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)

To run your own instance of Renovate you have several options:
### Contact and Social Media

- Install the `renovate` CLI tool from npmjs, run it on a schedule (e.g. using `cron`)
- 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)
The Renovate project is proudly supported and actively maintained by Mend.io.

[More details on the self-hosting development](https://github.com/renovatebot/renovate/blob/main/docs/usage/getting-started/running.md).
- Contact [Mend.io](https://www.mend.io/) for commercial support questions.

## Contributing
Follow us on:

If you want to contribute to Renovate or get a local copy running, please read the instructions in [contributing guidelines](.github/contributing.md).
To get started look at the [list of good first issues](https://github.com/renovatebot/renovate/contribute).
- Twitter: [x.com/mend_io](https://x.com/mend_io)
- LinkedIn: [linkedin.com/company/mend-io](https://linkedin.com/company/mend-io)

## Security / Disclosure

Expand Down

0 comments on commit 839ade1

Please sign in to comment.