annotate mercurial-dsl/HgVcsRoot.xml @ 1103:ee62597cacc3 release/2022.10 tip

release branch release/2022.10
author Nadia Burnasheva <nadezhda.burnasheva@jetbrains.com>
date Tue, 18 Oct 2022 09:46:26 +0200
parents 7e54839e1768
children
rev   line source
951
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
1 <?xml version="1.0" encoding="UTF-8"?>
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
2 <!--
977
38adef4f1b8f Update copyright
pavel.sher
parents: 961
diff changeset
3 ~ Copyright 2000-2018 JetBrains s.r.o.
951
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
4 ~
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
5 ~ Licensed under the Apache License, Version 2.0 (the "License");
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
6 ~ you may not use this file except in compliance with the License.
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
7 ~ You may obtain a copy of the License at
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
8 ~
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
9 ~ http://www.apache.org/licenses/LICENSE-2.0
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
10 ~
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
11 ~ Unless required by applicable law or agreed to in writing, software
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
12 ~ distributed under the License is distributed on an "AS IS" BASIS,
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
13 ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
14 ~ See the License for the specific language governing permissions and
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
15 ~ limitations under the License.
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
16 -->
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
17
953
ef995b1ed5ec update dsl attributes
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 952
diff changeset
18 <dsl-extension kind="vcs" type="mercurial" generateDslJar="true">
961
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
19 <class name="HgVcsRoot">
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
20 <description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
21 Mercurial [VCS root](https://confluence.jetbrains.com/display/TCDL/Mercurial)
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
22 </description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
23 </class>
951
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
24 <params>
970
ea15ebd45ba4 Mark mandatory fields
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 961
diff changeset
25 <param name="repositoryPath" dslName="url" mandatory="true">
961
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
26 <description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
27 Mercurial repository URL
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
28 </description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
29 </param>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
30 <param name="branchName" dslName="branch">
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
31 <description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
32 Default branch name
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
33 </description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
34 </param>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
35 <param name="teamcity:branchSpec" dslName="branchSpec">
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
36 <description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
37 [Branch specification](https://confluence.jetbrains.com/display/TCDL/Working+with+Feature+Branches#WorkingwithFeatureBranches-branchSpec)
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
38 to use in VCS root
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
39 </description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
40 </param>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
41 <param name="useTagsAsBranches" type="boolean">
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
42 <description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
43 Allows to use tags in branch specification. By default, tags are ignored.
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
44 </description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
45 </param>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
46 <param name="detectSubrepoChanges" type="boolean">
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
47 <description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
48 Whether TeamCity should detect changes in submodules
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
49 </description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
50 </param>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
51 <param name="tagUsername" dslName="userForTags">
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
52 <description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
53 A custom username for tags. Format: User Name &lt;email&gt;
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
54 </description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
55 </param>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
56 <param name="hgCommandPath" dslName="hgPath">
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
57 <description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
58 [Path](https://confluence.jetbrains.com/display/TCDL/Mercurial#Mercurial-hgDetection) to hg executable
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
59 </description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
60 </param>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
61 <param name="customHgConfig">
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
62 <description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
63 Mercurial configuration options to be applied to the repository in the
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
64 standard [format](https://www.selenic.com/mercurial/hgrc.5.html)
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
65 </description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
66 </param>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
67 <param name="username" dslName="userName">
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
68 <description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
69 A username for mercurial connection
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
70 </description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
71 </param>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
72 <param name="secure:password" dslName="password">
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
73 <description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
74 A password for mercurial connection
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
75 </description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
76 </param>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
77 <param name="purgePolicy" type="PurgePolicy">
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
78 <description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
79 Specifies whether TeamCity should run the [hg purge](https://www.mercurial-scm.org/wiki/PurgeExtension) command and what files should be purged
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
80 @see PurgePolicy
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
81 </description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
82 </param>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
83 <param name="useSharedMirrors" dslName="useMirrors" type="boolean">
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
84 <description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
85 When set to true, TeamCity creates a local agent mirror first (under agent's system/mercurial directory) and then clones to the
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
86 build [checkout directory](https://confluence.jetbrains.com/display/TCDL/Build+Checkout+Directory) from this local mirror.
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
87 This option speeds up clean checkout, because only the build working directory is cleaned.
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
88 Also, if a single root is used in several build configurations, a clone will be faster.
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
89 </description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
90 </param>
951
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
91 </params>
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
92 <types>
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
93 <enum name="PurgePolicy">
961
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
94 <description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
95 Defines [hg purge](https://www.mercurial-scm.org/wiki/PurgeExtension) settings
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
96 </description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
97 <option name="DONT_RUN">
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
98 <description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
99 Don't run the "hg purge"
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
100 </description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
101 </option>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
102 <option name="PURGE_UNKNOWN">
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
103 <description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
104 Purge unknown files and empty directories
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
105 </description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
106 </option>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
107 <option name="PURGE_ALL">
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
108 <description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
109 Purge unknown files, empty directories, and ignored files. Runs "hg purge --all".
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
110 </description>
075f3521bd02 documenting dsl
Dmitry Neverov <dmitry.neverov@gmail.com>
parents: 953
diff changeset
111 </option>
951
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
112 </enum>
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
113 </types>
0cf858cb793c Describe mercurial VCS root parameters
Dmitry Neverov <dmitry.neverov@gmail.com>
parents:
diff changeset
114 </dsl-extension>