Skip to content

Commit d808844

Browse files
committed
Refactor Auth to make GitHub Enterprise work
1 parent 3b616b4 commit d808844

File tree

69 files changed

+1482
-1304
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+1482
-1304
lines changed

docs/help.md

+39-26
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,12 @@ All command line arguments for the `scala-steward` application.
44

55
```
66
Usage:
7-
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] [--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]
7+
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] --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]
8+
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] --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]
9+
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] --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]
10+
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] --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]
11+
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] --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]
12+
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] [--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]
813
scala-steward validate-repo-config
914
1015
@@ -22,26 +27,50 @@ Options and flags:
2227
Git "user.email"
2328
--git-author-signing-key <string>
2429
Git "user.signingKey"
25-
--git-ask-pass <file>
26-
An executable file that returns the git credentials
2730
--sign-commits
2831
Whether to sign commits; default: false
29-
--forge-type <forge-type>
30-
One of azure-repos, bitbucket, bitbucket-server, github, gitlab, gitea; default: github
31-
--vcs-type <forge-type>
32-
deprecated in favor of --forge-type
32+
--azure-repos
33+
3334
--forge-api-host <uri>
34-
API URL of the forge; default: https://api.github.com
35+
API URL of the forge
3536
--vcs-api-host <uri>
3637
deprecated in favor of --forge-api-host
3738
--forge-login <string>
3839
The user name for the forge
3940
--vcs-login <string>
4041
deprecated in favor of --forge-login
41-
--do-not-fork
42-
Whether to not push the update branches to a fork; default: false
42+
--git-ask-pass <file>
43+
An executable file that returns the git credentials
4344
--add-labels
4445
Whether to add labels on pull or merge requests (if supported by the forge)
46+
--azure-repos-organization <string>
47+
The Azure organization (required with --azure-repos)
48+
--bitbucket
49+
50+
--do-not-fork
51+
Whether to not push the update branches to a fork; default: false
52+
--bitbucket-use-default-reviewers
53+
Whether to assign the default reviewers to a bitbucket pull request; default: false
54+
--bitbucket-server
55+
56+
--bitbucket-server-use-default-reviewers
57+
Whether to assign the default reviewers to a bitbucket server pull request; default: false
58+
--gitlab
59+
60+
--gitlab-merge-when-pipeline-succeeds
61+
Whether to merge a gitlab merge request when the pipeline succeeds
62+
--gitlab-required-reviewers <integer>
63+
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.
64+
--gitlab-remove-source-branch
65+
Flag indicating if a merge request should remove the source branch when merging.
66+
--gitea
67+
68+
--github
69+
70+
--github-app-id <integer>
71+
GitHub application id. Repos accessible by this app are added to the repos in repos.md. git-ask-pass is still required.
72+
--github-app-key-file <file>
73+
GitHub application key file. Repos accessible by this app are added to the repos in repos.md. git-ask-pass is still required.
4574
--ignore-opts-files
4675
Whether to remove ".jvmopts" and ".sbtopts" files before invoking the build tool
4776
--env-var <name=value>
@@ -72,22 +101,6 @@ Options and flags:
72101
Whether to disable the default artifact migration file
73102
--cache-ttl <duration>
74103
TTL for the caches; default: 2hours
75-
--bitbucket-use-default-reviewers
76-
Whether to assign the default reviewers to a bitbucket pull request; default: false
77-
--bitbucket-server-use-default-reviewers
78-
Whether to assign the default reviewers to a bitbucket server pull request; default: false
79-
--gitlab-merge-when-pipeline-succeeds
80-
Whether to merge a gitlab merge request when the pipeline succeeds
81-
--gitlab-required-reviewers <integer>
82-
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.
83-
--gitlab-remove-source-branch
84-
Flag indicating if a merge request should remove the source branch when merging.
85-
--azure-repos-organization <string>
86-
The Azure organization (required when --forge-type is azure-repos)
87-
--github-app-id <integer>
88-
GitHub application id. Repos accessible by this app are added to the repos in repos.md. git-ask-pass is still required.
89-
--github-app-key-file <file>
90-
GitHub application key file. Repos accessible by this app are added to the repos in repos.md. git-ask-pass is still required.
91104
--url-checker-test-url <uri>
92105
URL for testing the UrlChecker at start-up (can be used multiple times); default: https://github.com
93106
--default-maven-repo <string>

0 commit comments

Comments
 (0)