-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.html
291 lines (240 loc) · 8.66 KB
/
index.html
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
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
<!DOCTYPE html>
<html><head>
<meta name="generator" content="Hugo 0.74.3" />
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<link rel="canonical" href="https://docs.covergates.com/">
<title>
Covergates | Covergates Documentation
</title>
<link href="https://docs.covergates.com/css/fontawesome.min.css" rel="stylesheet">
<link rel="stylesheet" href="https://docs.covergates.com/css/ace.min.css">
</head><body><nav class="navbar navbar-expand-lg navbar-dark bg-primary shadow sticky-top" id="navbarMain">
<div class="container">
<div>
<img height="48" class="mx-2" src="/images/logo.png" />
<a class="navbar-brand" href="/">
Covergates Documentation
</a>
</div>
<button class="navbar-toggler navbar-toggler-right collapsed" type="button" data-toggle="collapse"
data-target="#navbarMainCollapse" aria-controls="navbarMainCollapse" aria-expanded="false"
aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse" id="navbarMainCollapse">
<ul class="navbar-nav ml-auto">
<li class="nav-item">
<a class="nav-link" href="https://covergates.com" target="_blank"
>
<i class='fas fa-home mx-1'></i> Website
</a>
</li>
<li class="nav-item">
<a class="nav-link" href="https://github.com/covergates/covergates" target="_blank"
>
<i class='fab fa-github mx-1'></i> GitHub
</a>
</li>
<li class="nav-item">
<a class="nav-link" href="https://github.com/covergates/covergates/releases" target="_blank"
>
<button class='btn btn-sm btn-success mt-n1'>Download</button>
</a>
</li>
</ul>
</div>
</div>
</nav><div class="container-fluid">
<div class="row">
<div class="docs-sidenav order-0 col-12 col-md-3 col-lg-2 col-xl-2 position-sticky border-right"><nav class="navbar navbar-expand-md navbar-light pl-0">
<button class="navbar-toggler navbar-toggler-right collapsed" type="button" data-toggle="collapse" data-target="#sidenav-left-collapse" aria-controls="sidenav-left-collapse" aria-expanded="false" aria-label="Toggle navigation">
<span class="navbar-toggler-icon"></span>
</button>
<div class="collapse navbar-collapse align-items-start flex-column" id="sidenav-left-collapse">
<form class="form-inline my-2 my-lg-0 searchbox">
<input class="form-control mr-sm-2 w-100" data-search-input id="search-by" type="text" placeholder="Search">
</form>
<ul class="navbar-nav flex-column pt-3">
<li data-nav-id="/start/" class="nav-item my-1 haschildren
">
<a class="nav-link p-0" href="/start/"><h6>Getting Started</h6></a>
<ul class="list-unstyled ml-2">
<li data-nav-id="/start/quick/" class="nav-item my-1">
<a href="/start/quick/" class="nav-link p-0">
Quick Start
</a>
</li>
<li data-nav-id="/start/cli/" class="nav-item my-1">
<a href="/start/cli/" class="nav-link p-0">
Command Line Tool
</a>
</li>
<li data-nav-id="/start/setting/" class="nav-item my-1">
<a href="/start/setting/" class="nav-link p-0">
Repository Setting
</a>
</li>
</ul>
</li>
<li data-nav-id="/language/" class="nav-item my-1
">
<a class="nav-link p-0" href="/language/"><h6>Supported Language</h6></a>
</li>
<li data-nav-id="/ci/" class="nav-item my-1
">
<a class="nav-link p-0" href="/ci/"><h6>Supported CI</h6></a>
</li>
<li data-nav-id="/server/" class="nav-item my-1 haschildren
">
<a class="nav-link p-0" href="/server/"><h6>Self-Hosted Server</h6></a>
<ul class="list-unstyled ml-2">
<li data-nav-id="/server/github/" class="nav-item my-1">
<a href="/server/github/" class="nav-link p-0">
Config GitHub
</a>
</li>
<li data-nav-id="/server/gitea/" class="nav-item my-1">
<a href="/server/gitea/" class="nav-link p-0">
Config Gitea
</a>
</li>
<li data-nav-id="/server/gitlab/" class="nav-item my-1">
<a href="/server/gitlab/" class="nav-link p-0">
Config GitLab
</a>
</li>
</ul>
</li>
</ul>
</div>
</nav>
</div>
<div class="docs-toc large order-lg-2 order-md-0 order-xs-1 col-12 col-lg-2 col-xl-2 position-sticky border-left"><div class="docs-toc">
<nav id="TableOfContents">
<ul>
<li><a href="#what-is-covergates">What is Covergates?</a></li>
<li><a href="#features">Features</a></li>
<li><a href="#coming-soon">Coming Soon</a></li>
</ul>
</nav>
</div>
</div>
<div class="main col-12 order-1 col-md-9 col-lg-10 col-xl-8 py-3">
<h1>Covergates</h1>
<p class="lead">
Welcome to Covergates User Guide!
</p>
<h2 id="what-is-covergates">What is Covergates?</h2>
<hr>
<p>Covergates is a self-hosted coverage reports management web service.
It’s an alternative to services like:</p>
<ul>
<li><a href="https://codeclimate.com/">Code Climate</a></li>
<li><a href="https://codecov.io/">Codecov</a></li>
<li><a href="https://coveralls.io/">Coveralls</a></li>
</ul>
<p>The goal of this project is to provide an easiest way
to deploy a self-hosted service to track code coverage.
You don’t need to have <strong>root permission</strong>, <strong>network connection</strong> or even <strong>database server</strong>
to run covergates.
Covergates is built with <strong><a href="https://golang.org/">Go</a></strong> language,
therefore it provides an independent binary distribution across all platforms that Go supports.
It includes Linux, Windows and macOS.</p>
<h2 id="features">Features</h2>
<hr>
<ul>
<li>
<p>Git Service Support</p>
<ul>
<li>Gitea</li>
<li>GitHub</li>
<li>GitLab</li>
</ul>
</li>
<li>
<p>Languages Support</p>
<ul>
<li>Go</li>
<li>Python</li>
<li>Ruby</li>
<li>Perl</li>
<li>C / C++</li>
<li>Javascript</li>
<li>TypeScript</li>
<li>PHP</li>
</ul>
</li>
<li>
<p>CI Tools</p>
<ul>
<li>GitHub Action</li>
<li>Drone</li>
</ul>
</li>
<li>
<p>Database</p>
<ul>
<li>SQLite</li>
<li>PostgreSQL</li>
<li>MySQL</li>
</ul>
</li>
<li>
<p>Web Service</p>
<ul>
<li>
<p>Source Code Coverage Highlight</p>
</li>
<li>
<p>Repository Setting Dashboard</p>
</li>
<li>
<p>Commits History</p>
</li>
<li>
<p>Promotions</p>
<ul>
<li>
<p>Coverage Badge <a href="https://covergates.com/report/github/covergates/covergates"><img src="https://covergates.com/api/v1/reports/bsi5dvi23akg00a0tgl0/badge?" alt="badge"></a></p>
</li>
<li>
<p>Repository Status Card</p>
<p><a href="https://covergates.com/report/github/covergates/covergates"><img src="https://covergates.com/api/v1/reports/bsi5dvi23akg00a0tgl0/card" alt="card"></a></p>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<h2 id="coming-soon">Coming Soon</h2>
<hr>
<p><i class='fas fa-wrench'></i> We are working on:</p>
<ul>
<li>
<p>Language Support</p>
<ul>
<li>Java</li>
<li>Others, <a href="https://github.com/covergates/covergates/issues">let us know the language you want!</a></li>
</ul>
</li>
</ul>
<div class="row"></div>
</div>
</div>
</div>
<script src="https://docs.covergates.com/lib/jquery.min.js"></script>
<script src="https://docs.covergates.com/lib/popper.min.js"></script>
<script src="https://docs.covergates.com/js/bootstrap.min.js"></script>
<script type="text/javascript" src="/plugins/lunr.min.js"></script>
<script type="text/javascript" src="/plugins/auto-complete.js"></script>
<link href="/plugins/auto-complete.css" rel="stylesheet">
<script type="text/javascript">
var baseurl = "https:\/\/docs.covergates.com";
</script>
<script type="text/javascript" src="/plugins/search.js"></script>
<script type="text/javascript" src="/plugins/clipboard.js"></script>
<script>
new ClipboardJS('.btn');
</script></body>
</html>