Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: describe intended ways to use Renovate #11197

Merged
Merged
11 changes: 11 additions & 0 deletions docs/development/design-decisions.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,17 @@

This file documents the design choices as well as configuration options.

## Intended usage by end-users
HonkingGoose marked this conversation as resolved.
Show resolved Hide resolved

Renovate is intended to be used as an app.
HonkingGoose marked this conversation as resolved.
Show resolved Hide resolved
It should not be used as a library, because it lacks a stable API.
HonkingGoose marked this conversation as resolved.
Show resolved Hide resolved

We do not want to create a stable API, or document our existing API.
HonkingGoose marked this conversation as resolved.
Show resolved Hide resolved
The API and documentation would need a major overhaul each time we refactor our code.

End users should only depend on the CLI or on the official hosted app.
The Renovate npm package should only be used as a CLI tool.

## Stateless

A key feature of Renovate is that it does not require any state storage (e.g. on disk or in a database).
Expand Down
11 changes: 11 additions & 0 deletions docs/usage/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,17 @@ The Renovate team will only create bugfixes for an older version if the hosted a
If you're using the hosted app, you don't need to do anything, as the Renovate maintainers update the hosted app regularly.
If you're self hosting Renovate, use the latest release if possible.

## Supported ways of using Renovate

Renovate is intended to be used as an app.
We do not support using Renovate as a library.

Supported ways to use Renovate:

- via the CLI program
- via the official hosted app
- via selfhosting the Renovate app

HonkingGoose marked this conversation as resolved.
Show resolved Hide resolved
## Renovate core features not supported on all platforms

| Feature | Platforms which lack feature | See Renovate issue(s) |
Expand Down