diff --git a/README.md b/README.md index 7c490ae0..7e4e3d0c 100644 --- a/README.md +++ b/README.md @@ -428,7 +428,7 @@ By default, Scala Steward will ignore "opts" files (such as `.jvmopts` or `.sbto
-
Run Scala Steward in debug mode
+
Run Scala Steward with step debug logging
You just need to enable [GitHub Actions' "step debug logging"](https://docs.github.com/en/actions/monitoring-and-troubleshooting-workflows/enabling-debug-logging#enabling-step-debug-logging) and Scala Steward will start automatically in debug mode too. @@ -443,6 +443,17 @@ For this you must set the following secret in the repository that contains the w
+
Running locally to attach a JVM debugger
+ +When debugging the behaviour of Scala Steward, it can be helpful to run Scala Steward +locally, while mimicking the settings used by the Scala Steward GitHub Action, so that +a debugger can be attached - [the Guardian have notes on how they do that](https://github.com/guardian/scala-steward-public-repos/blob/main/running-locally.md), +which may provide a helpful example if you need to do that in your own organisation. + +
+
+ +
Using the default GitHub Action Token (instead of the GitHub App)
If for any reason you want to use the default GitHub Token available in GitHub Actions, you won't be able to use the `github-app-*` inputs. Also beware that if you use the default github-token [no workflows will run](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow) on Scala Steward PRs. If you still want to use it you just need to remove all the `github-app-*` inputs and follow either the `Updating a specific repository` or the `Update specific repositories (listed on a file)` guides to provide a repository to update.