ChrisC | 025301d | 2017-01-31 11:40:03 +0100 | [diff] [blame] | 1 | <?xml version="1.0" encoding="UTF-8"?> |
| 2 | |
| 3 | <!-- |
| 4 | Licensed to the Apache Software Foundation (ASF) under one |
| 5 | or more contributor license agreements. See the NOTICE file |
| 6 | distributed with this work for additional information |
| 7 | regarding copyright ownership. The ASF licenses this file |
| 8 | to you under the Apache License, Version 2.0 (the |
| 9 | "License"); you may not use this file except in compliance |
| 10 | with the License. You may obtain a copy of the License at |
| 11 | |
| 12 | http://www.apache.org/licenses/LICENSE-2.0 |
| 13 | |
| 14 | Unless required by applicable law or agreed to in writing, |
| 15 | software distributed under the License is distributed on an |
| 16 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| 17 | KIND, either express or implied. See the License for the |
| 18 | specific language governing permissions and limitations |
| 19 | under the License. |
| 20 | --> |
| 21 | |
| 22 | |
| 23 | <!-- Special settings file for the maven installation on AT&T central Jenkins --> |
| 24 | |
| 25 | |
| 26 | <!-- |
| 27 | | This is the configuration file for Maven. It can be specified at two levels: |
| 28 | | |
| 29 | | 1. User Level. This settings.xml file provides configuration for a single user, |
| 30 | | and is normally provided in ${user.home}/.m2/settings.xml. |
| 31 | | |
| 32 | | NOTE: This location can be overridden with the CLI option: |
| 33 | | |
| 34 | | -s /path/to/user/settings.xml |
| 35 | | |
| 36 | | 2. Global Level. This settings.xml file provides configuration for all Maven |
| 37 | | users on a machine (assuming they're all using the same Maven |
| 38 | | installation). It's normally provided in |
| 39 | | ${maven.home}/conf/settings.xml. |
| 40 | | |
| 41 | | NOTE: This location can be overridden with the CLI option: |
| 42 | | |
| 43 | | -gs /path/to/global/settings.xml |
| 44 | | |
| 45 | | The sections in this sample file are intended to give you a running start at |
| 46 | | getting the most out of your Maven installation. Where appropriate, the default |
| 47 | | values (values used when the setting is not specified) are provided. |
| 48 | | |
| 49 | |--> |
| 50 | <settings xmlns="http://maven.apache.org/SETTINGS/1.0.0" |
| 51 | xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
| 52 | xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0 http://maven.apache.org/xsd/settings-1.0.0.xsd"> |
| 53 | <!-- localRepository |
| 54 | | The path to the local repository maven will use to store artifacts. |
| 55 | | |
| 56 | | Default: ${user.home}/.m2/repository |
| 57 | <localRepository>/path/to/local/repo</localRepository> |
| 58 | --> |
| 59 | <localRepository>${user.home}/.m2/repository</localRepository> |
| 60 | <!-- interactiveMode |
| 61 | | This will determine whether maven prompts you when it needs input. If set to false, |
| 62 | | maven will use a sensible default value, perhaps based on some other setting, for |
| 63 | | the parameter in question. |
| 64 | | |
| 65 | | Default: true |
| 66 | <interactiveMode>true</interactiveMode> |
| 67 | --> |
| 68 | |
| 69 | <!-- offline |
| 70 | | Determines whether maven should attempt to connect to the network when executing a build. |
| 71 | | This will have an effect on artifact downloads, artifact deployment, and others. |
| 72 | | |
| 73 | | Default: false |
| 74 | <offline>false</offline> |
| 75 | --> |
| 76 | |
| 77 | <!-- pluginGroups |
| 78 | | This is a list of additional group identifiers that will be searched when resolving plugins by their prefix, i.e. |
| 79 | | when invoking a command line like "mvn prefix:goal". Maven will automatically add the group identifiers |
| 80 | | "org.apache.maven.plugins" and "org.codehaus.mojo" if these are not already contained in the list. |
| 81 | |--> |
| 82 | <pluginGroups> |
| 83 | <!-- pluginGroup |
| 84 | | Specifies a further group identifier to use for plugin lookup. |
| 85 | <pluginGroup>com.your.plugins</pluginGroup> |
| 86 | --> |
| 87 | </pluginGroups> |
| 88 | |
| 89 | <!-- proxies |
| 90 | | This is a list of proxies which can be used on this machine to connect to the network. |
| 91 | | Unless otherwise specified (by system property or command-line switch), the first proxy |
| 92 | | specification in this list marked as active will be used. |
| 93 | |--> |
| 94 | <proxies> |
| 95 | <!-- proxy |
| 96 | | Specification for one proxy, to be used in connecting to the network. |
| 97 | | |
| 98 | <proxy> |
| 99 | <id>optional</id> |
| 100 | <active>true</active> |
| 101 | <protocol>http</protocol> |
| 102 | <username>proxyuser</username> |
| 103 | <password>proxypass</password> |
| 104 | <host>proxy.host.net</host> |
| 105 | <port>80</port> |
| 106 | <nonProxyHosts>local.net|some.host.com</nonProxyHosts> |
| 107 | </proxy> |
| 108 | --> |
| 109 | </proxies> |
| 110 | |
| 111 | <!-- servers |
| 112 | | This is a list of authentication profiles, keyed by the server-id used within the system. |
| 113 | | Authentication profiles can be used whenever maven must make a connection to a remote server. |
| 114 | |--> |
| 115 | <servers> |
| 116 | <!-- server |
| 117 | | Specifies the authentication information to use when connecting to a particular server, identified by |
| 118 | | a unique name within the system (referred to by the 'id' attribute below). |
| 119 | | |
| 120 | | NOTE: You should either specify username/password OR privateKey/passphrase, since these pairings are |
| 121 | | used together. |
| 122 | | |
| 123 | <server> |
| 124 | <id>deploymentRepo</id> |
| 125 | <username>repouser</username> |
| 126 | <password>repopwd</password> |
| 127 | </server> |
| 128 | --> |
| 129 | |
| 130 | <!-- Another sample, using keys to authenticate. |
| 131 | <server> |
| 132 | <id>siteServer</id> |
| 133 | <privateKey>/path/to/private/key</privateKey> |
| 134 | <passphrase>optional; leave empty if not used.</passphrase> |
| 135 | </server> |
| 136 | --> |
| 137 | </servers> |
| 138 | |
| 139 | <!-- mirrors |
| 140 | | This is a list of mirrors to be used in downloading artifacts from remote repositories. |
| 141 | | |
| 142 | | It works like this: a POM may declare a repository to use in resolving certain artifacts. |
| 143 | | However, this repository may have problems with heavy traffic at times, so people have mirrored |
| 144 | | it to several places. |
| 145 | | |
| 146 | | That repository definition will have a unique id, so we can create a mirror reference for that |
| 147 | | repository, to be used as an alternate download site. The mirror site will be the preferred |
| 148 | | server for that repository. |
| 149 | |--> |
| 150 | <mirrors> |
| 151 | <!-- mirror |
| 152 | | Specifies a repository mirror site to use instead of a given repository. The repository that |
| 153 | | this mirror serves has an ID that matches the mirrorOf element of this mirror. IDs are used |
| 154 | | for inheritance and direct lookup purposes, and must be unique across the set of mirrors. |
| 155 | | |
| 156 | --> |
ChrisC | 025301d | 2017-01-31 11:40:03 +0100 | [diff] [blame] | 157 | |
| 158 | </mirrors> |
| 159 | |
| 160 | <!-- profiles |
| 161 | | This is a list of profiles which can be activated in a variety of ways, and which can modify |
| 162 | | the build process. Profiles provided in the settings.xml are intended to provide local machine- |
| 163 | | specific paths and repository locations which allow the build to work in the local environment. |
| 164 | | |
| 165 | | For example, if you have an integration testing plugin - like cactus - that needs to know where |
| 166 | | your Tomcat instance is installed, you can provide a variable here such that the variable is |
| 167 | | dereferenced during the build process to configure the cactus plugin. |
| 168 | | |
| 169 | | As noted above, profiles can be activated in a variety of ways. One way - the activeProfiles |
| 170 | | section of this document (settings.xml) - will be discussed later. Another way essentially |
| 171 | | relies on the detection of a system property, either matching a particular value for the property, |
| 172 | | or merely testing its existence. Profiles can also be activated by JDK version prefix, where a |
| 173 | | value of '1.4' might activate a profile when the build is executed on a JDK version of '1.4.2_07'. |
| 174 | | Finally, the list of active profiles can be specified directly from the command line. |
| 175 | | |
| 176 | | NOTE: For profiles defined in the settings.xml, you are restricted to specifying only artifact |
| 177 | | repositories, plugin repositories, and free-form properties to be used as configuration |
| 178 | | variables for plugins in the POM. |
| 179 | | |
| 180 | |--> |
| 181 | <profiles> |
| 182 | <!-- profile |
| 183 | | Specifies a set of introductions to the build process, to be activated using one or more of the |
| 184 | | mechanisms described above. For inheritance purposes, and to activate profiles via <activatedProfiles/> |
| 185 | | or the command line, profiles have to have an ID that is unique. |
| 186 | | |
| 187 | | An encouraged best practice for profile identification is to use a consistent naming convention |
| 188 | | for profiles, such as 'env-dev', 'env-test', 'env-production', 'user-jdcasey', 'user-brett', etc. |
| 189 | | This will make it more intuitive to understand what the set of introduced profiles is attempting |
| 190 | | to accomplish, particularly when you only have a list of profile id's for debug. |
| 191 | | |
| 192 | | This profile example uses the JDK version to trigger activation, and provides a JDK-specific repo. |
| 193 | <profile> |
| 194 | <id>jdk-1.4</id> |
| 195 | |
| 196 | <activation> |
| 197 | <jdk>1.4</jdk> |
| 198 | </activation> |
| 199 | |
| 200 | <repositories> |
| 201 | <repository> |
| 202 | <id>jdk14</id> |
| 203 | <name>Repository for JDK 1.4 builds</name> |
| 204 | <url>http://www.myhost.com/maven/jdk14</url> |
| 205 | <layout>default</layout> |
| 206 | <snapshotPolicy>always</snapshotPolicy> |
| 207 | </repository> |
| 208 | </repositories> |
| 209 | </profile> |
| 210 | --> |
| 211 | |
| 212 | <!-- |
| 213 | | Here is another profile, activated by the system property 'target-env' with a value of 'dev', |
| 214 | | which provides a specific path to the Tomcat instance. To use this, your plugin configuration |
| 215 | | might hypothetically look like: |
| 216 | | |
| 217 | | ... |
| 218 | | <plugin> |
| 219 | | <groupId>org.myco.myplugins</groupId> |
| 220 | | <artifactId>myplugin</artifactId> |
| 221 | | |
| 222 | | <configuration> |
| 223 | | <tomcatLocation>${tomcatPath}</tomcatLocation> |
| 224 | | </configuration> |
| 225 | | </plugin> |
| 226 | | ... |
| 227 | | |
| 228 | | NOTE: If you just wanted to inject this configuration whenever someone set 'target-env' to |
| 229 | | anything, you could just leave off the <value/> inside the activation-property. |
| 230 | | |
| 231 | <profile> |
| 232 | <id>env-dev</id> |
| 233 | |
| 234 | <activation> |
| 235 | <property> |
| 236 | <name>target-env</name> |
| 237 | <value>dev</value> |
| 238 | </property> |
| 239 | </activation> |
| 240 | |
| 241 | <properties> |
| 242 | <tomcatPath>/path/to/tomcat/instance</tomcatPath> |
| 243 | </properties> |
| 244 | </profile> |
| 245 | --> |
| 246 | </profiles> |
| 247 | |
| 248 | <!-- activeProfiles |
| 249 | | List of profiles that are active for all builds. |
| 250 | | |
| 251 | <activeProfiles> |
| 252 | <activeProfile>alwaysActiveProfile</activeProfile> |
| 253 | <activeProfile>anotherAlwaysActiveProfile</activeProfile> |
| 254 | </activeProfiles> |
| 255 | --> |
| 256 | </settings> |