From 99711f2c76592639a9b6028e96526ab329381074 Mon Sep 17 00:00:00 2001
From: ceisele-r <54797986+ceisele-r@users.noreply.github.com>
Date: Fri, 7 May 2021 13:35:46 +0200
Subject: [PATCH] docs: add Troubleshooting hints to Readme

* add instruction how to enable debug logging
* add instructions about special token requirements when using github-actions manager
* remove dead license link from Readme
---
 README.md | 25 ++++++++++++++++++++++++-
 1 file changed, 24 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 528c5db8..e62a9a4f 100644
--- a/README.md
+++ b/README.md
@@ -11,7 +11,9 @@ GitHub Action to run Renovate self-hosted.
   - [`configurationFile`](#configurationfile)
   - [`token`](#token)
 - [Example](#example)
-- [License](#license)
+- [Troubleshooting](#troubleshooting)
+  - [Debug Logging](#debug-logging)
+  - [Special token requirements when using the `github-actions` manager](#special-token-requirements-when-using-the-github-actions-manager)
 
 ## Badges
 
@@ -51,6 +53,8 @@ If you want to use this with just the single configuration file, make sure to in
 
 Note that the [`GITHUB_TOKEN`](https://help.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token#permissions-for-the-github_token) secret can't be used for authenticating Renovate.
 
+Also note that if you want to use the `github-actions` manager, see the [special token requirements](#special-token-requirements-when-using-the-github-actions-manager).
+
 ## Example
 
 This example uses a personal access token and will run every 15 minutes. The personal access token is configured as a GitHub secret named `RENOVATE_TOKEN`. This example uses the [`example/config.js`](./example/config.js) file as configuration.
@@ -125,3 +129,22 @@ jobs:
           configurationFile: example/renovate-config.js
           token: 'x-access-token:${{ steps.get_token.outputs.app_token }}'
 ```
+
+## Troubleshooting
+
+### Debug Logging
+In case of issues, it's always a good idea to enable debug logging first.
+To enable debug logging, add the environment variable `LOG_LEVEL: 'debug'` to the action:
+```yml
+      - name: Self-hosted Renovate
+        uses: renovatebot/github-action@v21.30.0
+        with:
+          configurationFile: example/renovate-config.js
+          token: ${{ secrets.RENOVATE_TOKEN }}
+        env:
+          LOG_LEVEL: 'debug'
+```
+
+### Special token requirements when using the `github-actions` manager
+
+If you want to use the `github-actions` [manager](https://docs.renovatebot.com/modules/manager/github-actions/) in renovate, ensure that the `token` you provide contains the `workflow` scope. Otherwise, Github does not allow Renovate to update worklow files and therefore it will be unable to create update PR's for affected packages (like `actions/checkout` or `renovatebot/github-action` itself).