renovate/renovate
1
0
Fork 0
mirror of https://github.com/renovatebot/renovate.git synced 2025-01-11 22:46:27 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

docs: improve GitHub App installation documentation (#8001)

Browse source
This commit is contained in:
HonkingGoose 2020-12-15 09:21:22 +01:00 committed by GitHub
parent 748085646e
commit 51e11e5c75
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/usage/install-github-app.md
View file

@ -1,21 +1,22 @@
--- ---
title: GitHub App Installation title: GitHub App installation
description: How to install the Renovate GitHub App description: How to install the Renovate GitHub App
--- ---
# GitHub App Installation # GitHub app installation
Installing/Enabling the Renovate GitHub App is fairly simple, and no different to any other GitHub App. Installing/enabling the Renovate GitHub App is simple.
First, navigate to [https://github.com/apps/renovate](https://github.com/apps/renovate) and click the Install button: First, navigate to [https://github.com/apps/renovate](https://github.com/apps/renovate) and click the Install button:
![Github App Install button](assets/images/github-app-install.png) ![Github App Install button](assets/images/github-app-install.png)
The only choice you need to make is whether to run Renovate on: The only choice you need to make is whether to run Renovate on all repositories or on selected repositories:
![Github App repositories](assets/images/github-app-choose-repos.png) ![Github App repositories](assets/images/github-app-choose-repos.png)
Renovate will silently ignore any repositories that don't have known package files, as well as any forks, so it's OK to install for all, however most people choose to select which repositories to include. Renovate will ignore any repositories that don't have known package files, as well as any forks, so you can enable Renovate for all your repositories with no problems.
Unfortunately GitHub doesn't yet offer a "select all except X,Y,Z" so instead you need to individually select all that you want if you don't choose the install into all repositories option. That said, most people run Renovate on selected repositories.
Unfortunately GitHub doesn't offer a "select all except X,Y,Z" option, so you must select each repository where you want Renovate to run.
Once you're done selecting repositories for Renovate to run on, click the green Install button at the bottom of the page and Renovate will be enabled for those repositories and start the onboarding process. Once you're done selecting repositories for Renovate to run on, click the green Install button at the bottom of the page and Renovate will be enabled for those repositories and start the onboarding process.