Skip to content

Commit e02d918

Browse files
committed
Expand help strings for github-app-id and github-app-key-file
1 parent 684e2f3 commit e02d918

File tree

2 files changed

+10
-4
lines changed
  • docs
  • modules/core/src/main/scala/org/scalasteward/core/application

2 files changed

+10
-4
lines changed

docs/help.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,9 @@ Options and flags:
8383
--azure-repos-organization <string>
8484
The Azure organization (required when --forge-type is azure-repos)
8585
--github-app-id <integer>
86-
GitHub application id
86+
GitHub application id. Used to retrieve a list of repos for running scala-steward. This is used instead of repos.md, but git-ask-pass is still required.
8787
--github-app-key-file <file>
88-
GitHub application key file
88+
GitHub application key file. Used to retrieve a list of repos for running scala-steward. This is used instead of repos.md, but git-ask-pass is still required.
8989
--url-checker-test-url <uri>
9090
URL for testing the UrlChecker at start-up (can be used multiple times); default: https://github.com
9191
--default-maven-repo <string>

modules/core/src/main/scala/org/scalasteward/core/application/Cli.scala

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -284,10 +284,16 @@ object Cli {
284284
(gitlabMergeWhenPipelineSucceeds, gitlabRequiredReviewers).mapN(GitLabCfg.apply)
285285

286286
private val githubAppId: Opts[Long] =
287-
option[Long]("github-app-id", "GitHub application id")
287+
option[Long](
288+
"github-app-id",
289+
"GitHub application id. Used to retrieve a list of repos for running scala-steward. This is used instead of repos.md, but git-ask-pass is still required."
290+
)
288291

289292
private val githubAppKeyFile: Opts[File] =
290-
option[File]("github-app-key-file", "GitHub application key file")
293+
option[File](
294+
"github-app-key-file",
295+
"GitHub application key file. Used to retrieve a list of repos for running scala-steward. This is used instead of repos.md, but git-ask-pass is still required."
296+
)
291297

292298
private val gitHubApp: Opts[Option[GitHubApp]] =
293299
(githubAppId, githubAppKeyFile).mapN(GitHubApp.apply).orNone

0 commit comments

Comments
 (0)