Skip to content

Commit 902a25f

Browse files
committed
[OPENJDK-1964] Clarify permitted format for MAVEN_REPOS
Expand the documentation for MAVEN_REPOS to make it clear that it must be specified in uppercase, and that hyphens/dashes are replaced by underscores. Signed-off-by: Jonathan Dowland <[email protected]>
1 parent f55805d commit 902a25f

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

modules/maven/default/module.yaml

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,15 @@ envs:
6262
MAVEN_REPO_URL. The default is to generate a random ID.
6363
See MAVEN_REPOS for specifying multiple repositories.
6464
- name: "MAVEN_REPOS"
65-
example: "dev-one,qe-two"
66-
description: "If set, multi-repo support is enabled, and other MAVEN_REPO_* variables will be prefixed. For example: DEV_ONE_MAVEN_REPO_URL and QE_TWO_MAVEN_REPO_URL"
65+
example: "DEV-ONE,QE-TWO"
66+
description: >
67+
Enables multi-repo support. Specify a comma-delimited list of capitalized
68+
repository identifiers. The configuration for each repository will be
69+
determined by correspondingly prefixed `MAVEN_REPO_*` variables. Any dashes
70+
in repository names will be replaced with underscores. For example:
71+
Specifying `DEV-ONE,QE-TWO` configures two repositories and their
72+
URLs will be read from `DEV_ONE_MAVEN_REPO_URL` and
73+
`QE_TWO_MAVEN_REPO_URL`.
6774
- name: "prefix_MAVEN_REPO_ID"
6875
example: "my-repo-id"
6976
description: "Maven repository id"

0 commit comments

Comments
 (0)