1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
|
// Copyright 2015 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package com.google.devtools.build.lib.bazel.rules.workspace;
import static com.google.devtools.build.lib.packages.Attribute.attr;
import static com.google.devtools.build.lib.syntax.Type.BOOLEAN;
import static com.google.devtools.build.lib.syntax.Type.STRING;
import com.google.devtools.build.lib.analysis.RuleDefinition;
import com.google.devtools.build.lib.analysis.RuleDefinitionEnvironment;
import com.google.devtools.build.lib.packages.RuleClass;
/**
* Rule definition for the new_git_repository rule.
*/
public class NewGitRepositoryRule implements RuleDefinition {
public static final String NAME = "new_git_repository";
@Override
public RuleClass build(RuleClass.Builder builder, RuleDefinitionEnvironment environment) {
return builder
/* <!-- #BLAZE_RULE(new_git_repository).ATTRIBUTE(remote) -->
The URI of the remote Git repository.
${SYNOPSIS}
<p>This must be a HTTP URL. There is currently no support for authentication.</p>
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("remote", STRING).mandatory())
/* <!-- #BLAZE_RULE(git_repository).ATTRIBUTE(commit) -->
The commit hash to check out in the repository.
${SYNOPSIS}
<p>Note that one of either <code>commit</code> or <code>tag</code> must be defined.</p>
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("commit", STRING))
/* <!-- #BLAZE_RULE(git_repository).ATTRIBUTE(tag) -->
The Git tag to check out in the repository.
${SYNOPSIS}
<p>Note that one of either <code>commit</code> or <code>tag</code> must be defined.</p>
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("tag", STRING))
/* <!-- #BLAZE_RULE(new_git_repository).ATTRIBUTE(build_file) -->
The file to use as the BUILD file for this repository.
${SYNOPSIS}
<p>This path is relative to the build's workspace. The file does not need to be named
BUILD, but can be something like BUILD.new-repo-name to distinguish it
from the workspace's actual BUILD files.</p>
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("build_file", STRING).mandatory())
/* <!-- #BLAZE_RULE(new_git_repository).ATTRIBUTE(init_submodules) -->
Whether to clone submodules in the repository.
${SYNOPSIS}
<p>Currently, only cloning the top-level submodules is supported</p>
<!-- #END_BLAZE_RULE.ATTRIBUTE --> */
.add(attr("init_submodules", BOOLEAN).value(false))
.setWorkspaceOnly()
.build();
}
@Override
public Metadata getMetadata() {
return RuleDefinition.Metadata.builder()
.name(NewGitRepositoryRule.NAME)
.type(RuleClass.Builder.RuleClassType.WORKSPACE)
.ancestors(WorkspaceBaseRule.class)
.factoryClass(WorkspaceConfiguredTargetFactory.class)
.build();
}
}
/*<!-- #BLAZE_RULE (NAME = new_git_repository, TYPE = OTHER, FAMILY = Workspace)[GENERIC_RULE] -->
${ATTRIBUTE_SIGNATURE}
<p>Clones a Git repository, checks out the specified tag, or commit, and makes its targets
available for binding.</p>
${ATTRIBUTE_DEFINITION}
<h4 id="git_repository_examples">Examples</h4>
<p>Suppose the current repository contains the source code for a chat program, rooted at the
directory <i>~/chat-app</i>. It needs to depend on an SSL library which is available in the
remote Git repository <i>http://example.com/openssl/openssl.git</i>. The chat app depends
on version 1.0.2 of the SSL library, which is tagged by the v1.0.2 Git tag.<p>
<p>This Git repository contains the following directory structure:</p>
<pre class="code">
src/
openssl.cc
openssl.h
</pre>
<p>In the local repository, the user creates a <i>BUILD.ssl</i> file which contains the following
target definition:</p>
<pre class="code">
cc_library(
name = "openssl-lib",
srcs = ["openssl.cc"],
hdrs = ["openssl.h"],
)
</pre>
<p>Targets in the <i>~/chat-app</i> repository can depend on this target if the following lines are
added to <i>~/chat-app/WORKSPACE</i>:</p>
<pre class="code">
new_git_repository(
name = "my-ssl",
remote = "http://example.com/openssl/openssl.git",
tag = "v1.0.2",
build_file = "BUILD.ssl",
)
</pre>
<p>Then targets would specify <code>@my-ssl//src:openssl-lib</code> as a dependency.</p>
<!-- #END_BLAZE_RULE -->*/
|
