Refactor Auth to make GitHub Enterprise work

scala-steward-org · Oct 25, 2024 · 4d5d5a4 · 4d5d5a4
1 parent c05b98f
commit 4d5d5a4
Show file tree

Hide file tree

Showing 69 changed files with 1,483 additions and 1,305 deletions.
diff --git a/docs/help.md b/docs/help.md
@@ -4,7 +4,12 @@ All command line arguments for the `scala-steward` application.
 
 ```
 Usage:
-    scala-steward --workspace <file> --repos-file <uri> [--repos-file <uri>]... [--git-author-name <string>] --git-author-email <string> [--git-author-signing-key <string>] --git-ask-pass <file> [--sign-commits] [--signoff] [--forge-type <forge-type>] [--forge-api-host <uri>] --forge-login <string> [--do-not-fork] [--add-labels] [--ignore-opts-files] [--env-var <name=value>]... [--process-timeout <duration>] [--whitelist <string>]... [--read-only <string>]... [--enable-sandbox | --disable-sandbox] [--max-buffer-size <integer>] [--repo-config <uri>]... [--disable-default-repo-config] [--scalafix-migrations <uri>]... [--disable-default-scalafix-migrations] [--artifact-migrations <uri>]... [--disable-default-artifact-migrations] [--cache-ttl <duration>] [--bitbucket-use-default-reviewers] [--bitbucket-server-use-default-reviewers] [--gitlab-merge-when-pipeline-succeeds] [--gitlab-required-reviewers <integer>] [--gitlab-remove-source-branch] [--azure-repos-organization <string>] [--github-app-id <integer> --github-app-key-file <file>] [--url-checker-test-url <uri>]... [--default-maven-repo <string>] [--refresh-backoff-period <duration>] [--exit-code-success-if-any-repo-succeeds]
+    scala-steward --workspace <file> --repos-file <uri> [--repos-file <uri>]... [--git-author-name <string>] --git-author-email <string> [--git-author-signing-key <string>] [--sign-commits] [--signoff] --azure-repos --forge-api-host <uri> --forge-login <string> --git-ask-pass <file> [--add-labels] --azure-repos-organization <string> [--ignore-opts-files] [--env-var <name=value>]... [--process-timeout <duration>] [--whitelist <string>]... [--read-only <string>]... [--enable-sandbox | --disable-sandbox] [--max-buffer-size <integer>] [--repo-config <uri>]... [--disable-default-repo-config] [--scalafix-migrations <uri>]... [--disable-default-scalafix-migrations] [--artifact-migrations <uri>]... [--disable-default-artifact-migrations] [--cache-ttl <duration>] [--url-checker-test-url <uri>]... [--default-maven-repo <string>] [--refresh-backoff-period <duration>] [--exit-code-success-if-any-repo-succeeds]
+    scala-steward --workspace <file> --repos-file <uri> [--repos-file <uri>]... [--git-author-name <string>] --git-author-email <string> [--git-author-signing-key <string>] [--sign-commits] [--signoff] --bitbucket [--forge-api-host <uri>] --forge-login <string> --git-ask-pass <file> [--do-not-fork] [--bitbucket-use-default-reviewers] [--ignore-opts-files] [--env-var <name=value>]... [--process-timeout <duration>] [--whitelist <string>]... [--read-only <string>]... [--enable-sandbox | --disable-sandbox] [--max-buffer-size <integer>] [--repo-config <uri>]... [--disable-default-repo-config] [--scalafix-migrations <uri>]... [--disable-default-scalafix-migrations] [--artifact-migrations <uri>]... [--disable-default-artifact-migrations] [--cache-ttl <duration>] [--url-checker-test-url <uri>]... [--default-maven-repo <string>] [--refresh-backoff-period <duration>] [--exit-code-success-if-any-repo-succeeds]
+    scala-steward --workspace <file> --repos-file <uri> [--repos-file <uri>]... [--git-author-name <string>] --git-author-email <string> [--git-author-signing-key <string>] [--sign-commits] [--signoff] --bitbucket-server --forge-api-host <uri> --forge-login <string> --git-ask-pass <file> [--bitbucket-server-use-default-reviewers] [--ignore-opts-files] [--env-var <name=value>]... [--process-timeout <duration>] [--whitelist <string>]... [--read-only <string>]... [--enable-sandbox | --disable-sandbox] [--max-buffer-size <integer>] [--repo-config <uri>]... [--disable-default-repo-config] [--scalafix-migrations <uri>]... [--disable-default-scalafix-migrations] [--artifact-migrations <uri>]... [--disable-default-artifact-migrations] [--cache-ttl <duration>] [--url-checker-test-url <uri>]... [--default-maven-repo <string>] [--refresh-backoff-period <duration>] [--exit-code-success-if-any-repo-succeeds]
+    scala-steward --workspace <file> --repos-file <uri> [--repos-file <uri>]... [--git-author-name <string>] --git-author-email <string> [--git-author-signing-key <string>] [--sign-commits] [--signoff] --gitlab [--forge-api-host <uri>] --forge-login <string> --git-ask-pass <file> [--do-not-fork] [--add-labels] [--gitlab-merge-when-pipeline-succeeds] [--gitlab-required-reviewers <integer>] [--gitlab-remove-source-branch] [--ignore-opts-files] [--env-var <name=value>]... [--process-timeout <duration>] [--whitelist <string>]... [--read-only <string>]... [--enable-sandbox | --disable-sandbox] [--max-buffer-size <integer>] [--repo-config <uri>]... [--disable-default-repo-config] [--scalafix-migrations <uri>]... [--disable-default-scalafix-migrations] [--artifact-migrations <uri>]... [--disable-default-artifact-migrations] [--cache-ttl <duration>] [--url-checker-test-url <uri>]... [--default-maven-repo <string>] [--refresh-backoff-period <duration>] [--exit-code-success-if-any-repo-succeeds]
+    scala-steward --workspace <file> --repos-file <uri> [--repos-file <uri>]... [--git-author-name <string>] --git-author-email <string> [--git-author-signing-key <string>] [--sign-commits] [--signoff] --gitea --forge-api-host <uri> --forge-login <string> --git-ask-pass <file> [--do-not-fork] [--add-labels] [--ignore-opts-files] [--env-var <name=value>]... [--process-timeout <duration>] [--whitelist <string>]... [--read-only <string>]... [--enable-sandbox | --disable-sandbox] [--max-buffer-size <integer>] [--repo-config <uri>]... [--disable-default-repo-config] [--scalafix-migrations <uri>]... [--disable-default-scalafix-migrations] [--artifact-migrations <uri>]... [--disable-default-artifact-migrations] [--cache-ttl <duration>] [--url-checker-test-url <uri>]... [--default-maven-repo <string>] [--refresh-backoff-period <duration>] [--exit-code-success-if-any-repo-succeeds]
+    scala-steward --workspace <file> --repos-file <uri> [--repos-file <uri>]... [--git-author-name <string>] --git-author-email <string> [--git-author-signing-key <string>] [--sign-commits] [--signoff] [--github] [--forge-api-host <uri>] [--do-not-fork] [--add-labels] --github-app-id <integer> --github-app-key-file <file> [--ignore-opts-files] [--env-var <name=value>]... [--process-timeout <duration>] [--whitelist <string>]... [--read-only <string>]... [--enable-sandbox | --disable-sandbox] [--max-buffer-size <integer>] [--repo-config <uri>]... [--disable-default-repo-config] [--scalafix-migrations <uri>]... [--disable-default-scalafix-migrations] [--artifact-migrations <uri>]... [--disable-default-artifact-migrations] [--cache-ttl <duration>] [--url-checker-test-url <uri>]... [--default-maven-repo <string>] [--refresh-backoff-period <duration>] [--exit-code-success-if-any-repo-succeeds]
     scala-steward validate-repo-config
 
 
@@ -22,28 +27,52 @@ Options and flags:
         Git "user.email"
     --git-author-signing-key <string>
         Git "user.signingKey"
-    --git-ask-pass <file>
-        An executable file that returns the git credentials
     --sign-commits
         Whether to sign commits; default: false
     --signoff
         Whether to signoff commits; default: false
-    --forge-type <forge-type>
-        One of azure-repos, bitbucket, bitbucket-server, github, gitlab, gitea; default: github
-    --vcs-type <forge-type>
-        deprecated in favor of --forge-type
+    --azure-repos
+
     --forge-api-host <uri>
-        API URL of the forge; default: https://api.github.com
+        API URL of the forge
     --vcs-api-host <uri>
         deprecated in favor of --forge-api-host
     --forge-login <string>
         The user name for the forge
     --vcs-login <string>
         deprecated in favor of --forge-login
-    --do-not-fork
-        Whether to not push the update branches to a fork; default: false
+    --git-ask-pass <file>
+        An executable file that returns the git credentials
     --add-labels
         Whether to add labels on pull or merge requests (if supported by the forge)
+    --azure-repos-organization <string>
+        The Azure organization (required with --azure-repos)
+    --bitbucket
+
+    --do-not-fork
+        Whether to not push the update branches to a fork; default: false
+    --bitbucket-use-default-reviewers
+        Whether to assign the default reviewers to a bitbucket pull request; default: false
+    --bitbucket-server
+
+    --bitbucket-server-use-default-reviewers
+        Whether to assign the default reviewers to a bitbucket server pull request; default: false
+    --gitlab
+
+    --gitlab-merge-when-pipeline-succeeds
+        Whether to merge a gitlab merge request when the pipeline succeeds
+    --gitlab-required-reviewers <integer>
+        When set, the number of required reviewers for a merge request will be set to this number (non-negative integer).  Is only used in the context of gitlab-merge-when-pipeline-succeeds being enabled, and requires that the configured access token have the appropriate privileges.  Also requires a Gitlab Premium subscription.
+    --gitlab-remove-source-branch
+        Flag indicating if a merge request should remove the source branch when merging.
+    --gitea
+
+    --github
+
+    --github-app-id <integer>
+        GitHub application id. Repos accessible by this app are added to the repos in repos.md. git-ask-pass is still required.
+    --github-app-key-file <file>
+        GitHub application key file. Repos accessible by this app are added to the repos in repos.md. git-ask-pass is still required.
     --ignore-opts-files
         Whether to remove ".jvmopts" and ".sbtopts" files before invoking the build tool
     --env-var <name=value>
@@ -74,22 +103,6 @@ Options and flags:
         Whether to disable the default artifact migration file
     --cache-ttl <duration>
         TTL for the caches; default: 2hours
-    --bitbucket-use-default-reviewers
-        Whether to assign the default reviewers to a bitbucket pull request; default: false
-    --bitbucket-server-use-default-reviewers
-        Whether to assign the default reviewers to a bitbucket server pull request; default: false
-    --gitlab-merge-when-pipeline-succeeds
-        Whether to merge a gitlab merge request when the pipeline succeeds
-    --gitlab-required-reviewers <integer>
-        When set, the number of required reviewers for a merge request will be set to this number (non-negative integer).  Is only used in the context of gitlab-merge-when-pipeline-succeeds being enabled, and requires that the configured access token have the appropriate privileges.  Also requires a Gitlab Premium subscription.
-    --gitlab-remove-source-branch
-        Flag indicating if a merge request should remove the source branch when merging.
-    --azure-repos-organization <string>
-        The Azure organization (required when --forge-type is azure-repos)
-    --github-app-id <integer>
-        GitHub application id. Repos accessible by this app are added to the repos in repos.md. git-ask-pass is still required.
-    --github-app-key-file <file>
-        GitHub application key file. Repos accessible by this app are added to the repos in repos.md. git-ask-pass is still required.
     --url-checker-test-url <uri>
         URL for testing the UrlChecker at start-up (can be used multiple times); default: https://github.com
     --default-maven-repo <string>