← Back to branch summary

~ubuntu-branches/ubuntu/trusty/wagon2/trusty-proposed

« back to all changes in this revision

Viewing changes to wagon-providers/wagon-scm/src/site/apt/usage.apt.vm

  • Committer: Package Import Robot
  • Author(s): Damien Raude-Morvan
  • Date: 2012-01-29 23:23:22 UTC
  • Revision ID: package-import@ubuntu.com-20120129232322-w9h5j9c81zi8f23o
Tags: upstream-2.2
Import upstream version 2.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
wagon-providers/wagon-scm/src/site/apt/usage.apt.vm
 
1
 ------
 
2
 Maven Wagon SCM
 
3
 ------
 
4
 Carlos Sanchez
 
5
 ------
 
6
 2011-09-22
 
7
 ------
 
8
 
 
9
 ~~ Licensed to the Apache Software Foundation (ASF) under one
 
10
 ~~ or more contributor license agreements.  See the NOTICE file
 
11
 ~~ distributed with this work for additional information
 
12
 ~~ regarding copyright ownership.  The ASF licenses this file
 
13
 ~~ to you under the Apache License, Version 2.0 (the
 
14
 ~~ "License"); you may not use this file except in compliance
 
15
 ~~ with the License.  You may obtain a copy of the License at
 
16
 ~~
 
17
 ~~   http://www.apache.org/licenses/LICENSE-2.0
 
18
 ~~
 
19
 ~~ Unless required by applicable law or agreed to in writing,
 
20
 ~~ software distributed under the License is distributed on an
 
21
 ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 
22
 ~~ KIND, either express or implied.  See the License for the
 
23
 ~~ specific language governing permissions and limitations
 
24
 ~~ under the License.
 
25
 
 
26
 ~~ NOTE: For help with the syntax of this file, see:
 
27
 ~~ http://maven.apache.org/doxia/references/apt-format.html
 
28
 
 
29
Maven Wagon SCM Usage
 
30
 
 
31
 You need to add some extensions
 
32
 (wagon-scm, maven-scm-manager-plexus and the maven-scm-provider for your SCM system, see examples below)
 
33
 to your pom and use URLs in the
 
34
 {{{http://maven.apache.org/scm/scm-url-format.html}SCM format}}.
 
35
 
 
36
 For non-subversion SCM, in your settings.xml file you can include the elements <<<scmVersionType>>> and <<<scmVersion>>> to
 
37
 specify a branch or tag to use. The value of <<<scmVersionType>>> must be one of <<<branch>>> or <<<tag>>>.
 
38
 There is no default value for <<<scmVersionType>>> so you <MUST> specify it with <<<scmVersion>>> in order
 
39
 to have any effect.
 
40
 
 
41
 
 
42
Deploying your Maven site to Subversion
 
43
 
 
44
 Add the following extensions to your pom and use a wagon-scm url in the distributionManagement site url.
 
45
 
 
46
------
 
47
  <build>
 
48
    <extensions>
 
49
      <extension>
 
50
        <groupId>org.apache.maven.wagon</groupId>
 
51
        <artifactId>wagon-scm</artifactId>
 
52
        <version>${project.version}</version>
 
53
      </extension>
 
54
      <extension>
 
55
        <groupId>org.apache.maven.scm</groupId>
 
56
        <artifactId>maven-scm-manager-plexus</artifactId>
 
57
        <version>${mavenScmVersion}</version>
 
58
      </extension>
 
59
      <extension>
 
60
        <groupId>org.apache.maven.scm</groupId>
 
61
        <artifactId>maven-scm-provider-svnexe</artifactId>
 
62
        <version>${mavenScmVersion}</version>
 
63
      </extension>
 
64
    </extensions>
 
65
  </build>
 
66
  <distributionManagement>
 
67
    <site>
 
68
      <id>my.svn.server</id>
 
69
      <url>scm:svn:https://username@svn.apache.org/svn/root/module</url>
 
70
    </site>
 
71
  </distributionManagement>
 
72
------
 
73
 
 
74
 
 
75
Deploying your Maven site to CVS
 
76
 
 
77
 Same as before, but changing svnexe to cvsexe and using a CVS svn url.
 
78
 
 
79
------
 
80
  <build>
 
81
    <extensions>
 
82
      <extension>
 
83
        <groupId>org.apache.maven.wagon</groupId>
 
84
        <artifactId>wagon-scm</artifactId>
 
85
        <version>${project.version}</version>
 
86
      </extension>
 
87
      <extension>
 
88
        <groupId>org.apache.maven.scm</groupId>
 
89
        <artifactId>maven-scm-manager-plexus</artifactId>
 
90
        <version>${mavenScmVersion}</version>
 
91
      </extension>
 
92
      <extension>
 
93
        <groupId>org.apache.maven.scm</groupId>
 
94
        <artifactId>maven-scm-provider-cvsexe</artifactId>
 
95
        <version>${mavenScmVersion}</version>
 
96
      </extension>
 
97
    </extensions>
 
98
  </build>
 
99
  <distributionManagement>
 
100
    <site>
 
101
      <id>my.cvs.server</id>
 
102
      <url>scm:cvs:ext:username@cvs.apache.org:/cvs/root:module</url>
 
103
    </site>
 
104
  </distributionManagement>
 
105
------
 
106
 
 
107
 
 
108
Deploying your Maven site to GitHub's gh-pages
 
109
 
 
110
 Same as before, but changing svnexe to gitexe and using a Git svn url.
 
111
 
 
112
------
 
113
  <build>
 
114
    <extensions>
 
115
      <extension>
 
116
        <groupId>org.apache.maven.wagon</groupId>
 
117
        <artifactId>wagon-scm</artifactId>
 
118
        <version>${project.version}</version>
 
119
      </extension>
 
120
      <extension>
 
121
        <groupId>org.apache.maven.scm</groupId>
 
122
        <artifactId>maven-scm-manager-plexus</artifactId>
 
123
        <version>${project.version}</version>
 
124
      </extension>
 
125
      <extension>
 
126
        <groupId>org.apache.maven.scm</groupId>
 
127
        <artifactId>maven-scm-provider-gitexe</artifactId>
 
128
        <version>${project.version}</version>
 
129
      </extension>
 
130
    </extensions>
 
131
  </build>
 
132
  <distributionManagement>
 
133
    <site>
 
134
      <id>my.git.server</id>
 
135
      <url>scm:git:ssh://git@github.com/myuser/myproject.git</url>
 
136
    </site>
 
137
  </distributionManagement>
 
138
------
 
139
 
 
140
 And in your settings.xml file:
 
141
 
 
142
------
 
143
  <server>
 
144
    <id>my.git.server</id>
 
145
    <username>git</username>
 
146
    <scmVersionType>branch</scmVersionType>
 
147
    <scmVersion>gh-pages</scmVersion>
 
148
  </server>
 
149
------
 
150
 
 
151
 
 
152
 
 
153
Using a Subversion based remote repository in Maven 2
 
154
 
 
155
 Not tested yet
 
156
 
 
157
 
 
158
Using a CVS based remote repository in Maven 2
 
159
 
 
160
 Not tested yet