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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
|
# Copyright Nicolas (2023)
#
# * Nicolas Paul
#
# This software is a computer program whose purpose is to allow the hosting
# and sharing of Go modules using a personal domain.
#
# This software is governed by the CeCILL license under French law and
# abiding by the rules of distribution of free software. You can use,
# modify and/ or redistribute the software under the terms of the CeCILL
# license as circulated by CEA, CNRS and INRIA at the following URL
# "http://www.cecill.info".
#
# As a counterpart to the access to the source code and rights to copy,
# modify and redistribute granted by the license, users are provided only
# with a limited warranty and the software's author, the holder of the
# economic rights, and the successive licensors have only limited
# liability.
#
# In this respect, the user's attention is drawn to the risks associated
# with loading, using, modifying and/or developing or reproducing the
# software by the user in light of its specific status of free software,
# that may mean that it is complicated to manipulate, and that also
# therefore means that it is reserved for developers and experienced
# professionals having in-depth computer knowledge. Users are therefore
# encouraged to load and test the software's suitability as regards their
# requirements in conditions enabling the security of their systems and/or
# data to be ensured and, more generally, to use and operate it in the
# same conditions as regards security.
#
# The fact that you are presently reading this means that you have had
# knowledge of the CeCILL license and that you accept its terms.
# Utilities to index Go modules hosted on Git repositories.
_GIT = "git"
# https://github.com/github/renaming
_GITHUB_DEFAULT_INSTANCE = "https://github.com"
_GITHUB_DEFAULT_REF = "main"
def _github(
name,
user,
repo,
ref = _GITHUB_DEFAULT_REF,
instance = _GITHUB_DEFAULT_INSTANCE):
"""Register a module hosted on GitHub.
Args:
name (str): The name of the module.
user (str): The name of the user or organization.
repo (str): The name of the repository.
ref (str): The name of the ref.
Defaults to `git.GITHUB_DEFAULT_REF`.
instance (str): The name of the instance.
Defaults to `git.GITHUB_DEFAULT_INSTANCE`.
"""
return module(
name = name,
vcs = _GIT,
repo = "%s/%s/%s" % (instance, user, repo),
dir = "%s/%s/%s/tree/%s{/dir}" % (instance, user, repo, ref),
file = "%s/%s/%s/blob/%s{/dir}/{file}#L{line}" %
(instance, user, repo, ref),
)
_SOURCEHUT_DEFAULT_INSTANCE = "https://git.sr.ht"
_SOURCEHUT_DEFAULT_REF = "master"
# TODO(nc0): See the status for organizations and groups, as they are expected
# to use another symbol than `~`.
def _sourcehut(
name,
user,
repo,
ref = _SOURCEHUT_DEFAULT_REF,
instance = _SOURCEHUT_DEFAULT_INSTANCE):
"""Register a module hosted on Source Hut's Git hosting.
Args:
name (str): The name of the module.
user (str): The name of the user or organization.
repo (str): The name of the repository.
ref (str): The name of the ref.
Defaults to `git.SOURCEHUT_DEFAULT_REF`.
instance (str): The name of the instance.
Defaults to `git.SOURCEHUT_DEFAULT_INSTANCE`.
"""
return module(
name = name,
vcs = _GIT,
repo = "%s/~%s/%s" % (instance, user, repo),
dir = "%s/~%s/%s/tree/%s{/dir}" %
(instance, user, repo, ref),
file = "%s/~%s/%s/tree/%s/item{/dir}/{file}#L{line}" %
(instance, user, repo, ref),
)
# https://about.gitlab.com/blog/2021/03/10/new-git-default-branch-name/
_GITLAB_DEFAULT_INSTANCE = "https://gitlab.com"
_GITLAB_DEFAULT_REF = "main"
def _gitlab(
name,
user,
repo,
ref = _GITLAB_DEFAULT_REF,
instance = _GITLAB_DEFAULT_INSTANCE):
"""Register a module hosted on GitLab.
Args:
name (str): The name of the module.
user (str): The name of the user or organization.
repo (str): The name of the repository.
ref (str): The name of the ref.
Defaults to `git.GITLAB_DEFAULT_REF`.
instance (str): The name of the instance.
Defaults to `git.GITLAB_DEFAULT_INSTANCE`.
"""
return module(
name = name,
vcs = _GIT,
repo = "%s/%s/%s" % (instance, user, repo),
dir = "%s/%s/%s/-/tree/%s{/dir}" % (instance, user, repo, ref),
file = "%s/%s/%s/-/blob/%s{/dir}/{file}#L{line}" %
(instance, user, repo, ref),
)
# https://confluence.atlassian.com/bitbucketserver/setting-a-system-wide-default-branch-name-1021220665.html
_BITBUCKET_DEFAULT_INSTANCE = "https://bitbucket.org"
_BITBUCKET_DEFAULT_REF = "master"
def _bitbucket(
name,
workspace,
repo,
ref = _BITBUCKET_DEFAULT_REF,
instance = _BITBUCKET_DEFAULT_INSTANCE):
"""Register a module hosted on Bitbucket.
By default, we use https://bitbucket.org, however you usually need to
change it with your username and workspace, following:
https://<username>@bitbucket.org/<workspace>
Args:
name (str): The name of the module.
workspace (str): The ID of the workspace.
repo (str): The name of the repository.
ref (str): The name of the ref.
Defaults to `git.BITBUCKET_DEFAULT_REF`.
instance (str): The name of the instance.
Defaults to `git.BITBUCKET_DEFAULT_INSTANCE`.
"""
return module(
name = name,
vcs = _GIT,
repo = "%s/%s/%s" % (instance, workspace, repo),
dir = "%s/%s/%s/src/%s{/dir}" % (instance, workspace, repo, ref),
file = "%s/%s/%s/src/%s{/dir}/{file}#{file}-{line}" %
(instance, workspace, repo, ref),
)
_GITILES_DEFAULT_REF = "master"
def _gitiles(
name,
instance,
repo,
ref = _GITILES_DEFAULT_REF):
"""Register a module hosted a Gitiles (Gerrit) installation.
Args:
name (str): The name of the module.
instance (str): The Gitiles instance URL.
repo (str): The repository path.
ref (str): The name of the ref.
Defaults to `git.GITILES_DEFAULT_REF`.
"""
return module(
name = name,
vcs = _GIT,
repo = "%s/%s" % (instance, repo),
dir = "%s/%s/+/refs/heads/%s{/dir}" % (instance, repo, ref),
file = "%s/%s/+/refs/heads/%s{/dir}/{file}#{line}" %
(instance, repo, ref),
)
git = make_module(
"git",
GIT = _GIT,
GITHUB_DEFAULT_INSTANCE = _GITHUB_DEFAULT_INSTANCE,
GITHUB_DEFAULT_REF = _GITHUB_DEFAULT_REF,
SOURCEHUT_DEFAULT_INSTANCE = _SOURCEHUT_DEFAULT_INSTANCE,
SOURCEHUT_DEFAULT_REF = _SOURCEHUT_DEFAULT_REF,
GITLAB_DEFAULT_INSTANCE = _GITLAB_DEFAULT_INSTANCE,
GITLAB_DEFAULT_REF = _GITLAB_DEFAULT_REF,
BITBUCKET_DEFAULT_INSTANCE = _BITBUCKET_DEFAULT_INSTANCE,
BITBUCKET_DEFAULT_REF = _BITBUCKET_DEFAULT_REF,
GITILES_DEFAULT_REF = _GITILES_DEFAULT_REF,
github = _github,
sourcehut = _sourcehut,
gitlab = _gitlab,
bitbucket = _bitbucket,
gitiles = _gitiles,
)
|
