-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathstart.html
More file actions
292 lines (271 loc) · 13.9 KB
/
start.html
File metadata and controls
292 lines (271 loc) · 13.9 KB
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
292
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Get started - depmedic ci-doctor (5 CI providers, one snippet) - depmedic</title>
<meta name="description" content="Pick your CI provider, copy the snippet, ship. ci-doctor audits cost + security + reliability for GitHub Actions, GitLab CI, Bitbucket Pipelines, Azure Pipelines, CircleCI. Free, MIT, no signup." />
<link rel="canonical" href="https://depmedicdev-byte.github.io/start.html" />
<meta name="theme-color" content="#0b0d10" />
<meta property="og:title" content="Get started with ci-doctor - 5 CI providers, one snippet" />
<meta property="og:description" content="Drop one job into your pipeline. ci-doctor audits cost waste + security gaps + reliability bugs in <1s. Free, MIT, no signup. 5 CI providers." />
<meta property="og:url" content="https://depmedicdev-byte.github.io/start.html" />
<meta property="og:type" content="website" />
<script type="application/ld+json">{
"@context": "https://schema.org",
"@type": "HowTo",
"name": "Get started with ci-doctor in 60 seconds",
"description": "Pick your CI provider, copy the snippet, push. ci-doctor audits cost + security + reliability for GitHub Actions, GitLab CI, Bitbucket Pipelines, Azure Pipelines, CircleCI.",
"totalTime": "PT1M",
"tool": [{ "@type": "HowToTool", "name": "Node.js (already on your CI runner)" }],
"step": [
{ "@type": "HowToStep", "position": 1, "name": "Pick your CI provider", "text": "Choose GitHub Actions, GitLab CI, Bitbucket Pipelines, Azure Pipelines, or CircleCI." },
{ "@type": "HowToStep", "position": 2, "name": "Copy the snippet", "text": "Copy the 1-3 line snippet for your provider into your pipeline file." },
{ "@type": "HowToStep", "position": 3, "name": "Push and review", "text": "On the next CI run, ci-doctor prints a Markdown table of findings and (on GitHub) posts a sticky PR comment." }
]
}</script>
<script type="application/ld+json">{
"@context": "https://schema.org",
"@type": "FAQPage",
"mainEntity": [
{
"@type": "Question",
"name": "Does ci-doctor support self-hosted runners?",
"acceptedAnswer": { "@type": "Answer", "text": "Yes. The audit runs against the workflow YAML, regardless of where the runner lives." }
},
{
"@type": "Question",
"name": "Does ci-doctor support reusable workflows?",
"acceptedAnswer": { "@type": "Answer", "text": "Yes. It follows uses: references and audits the referenced workflow if it lives in the same repo. Cross-repo references are flagged for manual review." }
},
{
"@type": "Question",
"name": "Does ci-doctor work in monorepos?",
"acceptedAnswer": { "@type": "Answer", "text": "Yes. Point it at a directory and it audits every workflow file under it, including nested .github/workflows trees from packages inside the monorepo." }
},
{
"@type": "Question",
"name": "Is ci-doctor free?",
"acceptedAnswer": { "@type": "Answer", "text": "Yes. The CLI and companion Action are MIT-licensed and free forever. The optional Pro tier ($5/mo) adds per-org rule overrides, Slack/Webhook delivery, and a hosted GitHub App with one-click install." }
}
]
}</script>
<style>
:root { color-scheme: dark; } * { box-sizing: border-box; } html, body { margin: 0; padding: 0; }
body { background: #0b0d10; color: #e6e8eb;
font: 16px/1.55 ui-sans-serif, system-ui, -apple-system, "Segoe UI", Roboto, sans-serif; -webkit-font-smoothing: antialiased; }
a { color: #6cb6ff; text-decoration: none; } a:hover { text-decoration: underline; }
main { max-width: 880px; margin: 0 auto; padding: 40px 20px 80px; }
.nav { color: #9aa3ad; font-size: 14px; margin: 0 0 16px; } .nav a { color: #9aa3ad; }
h1 { font-size: 32px; letter-spacing: -0.01em; margin: 0 0 6px; }
.lead { color: #b6bec7; max-width: 64ch; margin: 0 0 22px; font-size: 17px; }
h2 { font-size: 22px; margin: 36px 0 8px; letter-spacing: -0.005em; }
h3 { font-size: 17px; margin: 16px 0 4px; }
pre, code { background: #11151b; border: 1px solid #1e242c; border-radius: 6px; padding: 0 6px;
font: 13px/1.55 ui-monospace, SFMono-Regular, "Cascadia Mono", Menlo, monospace; color: #c9d1d9; }
pre { padding: 12px 14px; overflow-x: auto; margin: 8px 0 16px; position: relative; }
pre.good { border-left: 3px solid #9ce29c; }
.tabs { display: flex; gap: 6px; flex-wrap: wrap; margin: 16px 0 6px; }
.tab { padding: 10px 14px; border: 1px solid #2a3744; background: #11151b; color: #c9d1d9;
border-radius: 6px; cursor: pointer; font: inherit; font-size: 14px; }
.tab.active { background: #1e2a38; color: #9ec9ff; border-color: #3a4754; }
.panel { display: none; }
.panel.active { display: block; }
.cta { background: linear-gradient(135deg, #16202b, #1e2a38);
border: 1px solid #3a4754; border-radius: 12px; padding: 22px 24px; margin: 32px 0 16px; }
.cta h3 { margin: 0 0 6px; font-size: 17px; }
.cta p { margin: 0 0 10px; color: #b6bec7; font-size: 14px; }
.cta .btn { display: inline-block; padding: 10px 18px; border-radius: 8px;
background: #2a3744; color: #e6e8eb; font-weight: 500; border: 1px solid #3a4754; margin-right: 8px; }
.cta .btn.primary { background: #1e3a4a; border-color: #2c5872; color: #a3d4ff; }
.cta .btn:hover { text-decoration: none; background: #3a4754; }
.steps { counter-reset: step; padding: 0; margin: 16px 0; list-style: none; }
.steps > li { counter-increment: step; padding: 8px 0 8px 36px; position: relative; }
.steps > li::before { content: counter(step); position: absolute; left: 0; top: 6px;
width: 24px; height: 24px; line-height: 24px; text-align: center;
background: #1e2a38; color: #9ec9ff; border-radius: 50%; font-size: 12px; font-weight: 600; }
.copy-btn { position: absolute; top: 6px; right: 6px; padding: 4px 10px; border: 1px solid #2a3744;
background: #1e2a38; color: #9ec9ff; border-radius: 4px; font-size: 11px; cursor: pointer; }
.copy-btn:hover { background: #2a3744; }
footer { margin-top: 44px; color: #6f7882; font-size: 13px; border-top: 1px solid #1e242c; padding-top: 16px; }
</style>
</head>
<body>
<main>
<p class="nav"><a href="/">depmedic</a> / start</p>
<h1>Get started in 60 seconds</h1>
<p class="lead">
Pick your CI provider, copy the snippet, push. ci-doctor runs in
<1s and reports cost waste, security gaps, and reliability bugs.
Free, MIT, no signup. Five CI providers covered.
</p>
<h2>Step 1. Pick your CI provider</h2>
<div class="tabs" role="tablist">
<button class="tab active" data-tab="gha">GitHub Actions</button>
<button class="tab" data-tab="gitlab">GitLab CI</button>
<button class="tab" data-tab="bitbucket">Bitbucket Pipelines</button>
<button class="tab" data-tab="azure">Azure Pipelines</button>
<button class="tab" data-tab="circleci">CircleCI</button>
</div>
<div class="panel active" id="panel-gha">
<h3>Recommended: drop in the Action (3 lines)</h3>
<pre class="good"><button class="copy-btn" data-target="snip-gha-action">copy</button><code id="snip-gha-action">- uses: depmedicdev-byte/ci-doctor-action@v1
with:
severity-threshold: warn
comment-on-pr: true
upload-sarif: true</code></pre>
<p>Or run the CLI directly:</p>
<pre class="good"><button class="copy-btn" data-target="snip-gha-cli">copy</button><code id="snip-gha-cli">- run: npx --yes ci-doctor --markdown</code></pre>
<p>Other useful pages: <a href="/ci-doctor-action.html">Action docs</a> ·
<a href="/scan.html">scan a workflow in your browser</a> ·
<a href="/leaderboard.html">public leaderboard</a>.</p>
</div>
<div class="panel" id="panel-gitlab">
<h3>Drop into your pipeline (1 job)</h3>
<pre class="good"><button class="copy-btn" data-target="snip-gitlab">copy</button><code id="snip-gitlab">ci-audit:
stage: lint
image: node:20-alpine
script:
- npx --yes gitlab-ci-doctor --markdown | tee ci-doctor.md
artifacts:
paths: [ci-doctor.md]
expire_in: 1 week
allow_failure: true</code></pre>
<p>Other useful pages: <a href="/gitlab-ci-doctor.html">gitlab-ci-doctor docs</a> ·
<a href="/scan-gitlab.html">scan in browser</a>.</p>
</div>
<div class="panel" id="panel-bitbucket">
<h3>Drop into your pipeline (1 step)</h3>
<pre class="good"><button class="copy-btn" data-target="snip-bitbucket">copy</button><code id="snip-bitbucket">image: node:20-alpine
pipelines:
default:
- step:
name: ci-audit
script:
- npx --yes bitbucket-ci-doctor --markdown</code></pre>
<p>Other useful pages: <a href="/bitbucket-ci-doctor.html">bitbucket-ci-doctor docs</a> ·
<a href="/scan-bitbucket.html">scan in browser</a>.</p>
</div>
<div class="panel" id="panel-azure">
<h3>Drop into your pipeline (1 task)</h3>
<pre class="good"><button class="copy-btn" data-target="snip-azure">copy</button><code id="snip-azure">- task: Bash@3
displayName: ci-doctor
inputs:
targetType: inline
script: npx --yes azure-pipelines-ci-doctor --markdown</code></pre>
<p>Other useful pages: <a href="/azure-pipelines-ci-doctor.html">azure-pipelines-ci-doctor docs</a> ·
<a href="/scan-azure.html">scan in browser</a>.</p>
</div>
<div class="panel" id="panel-circleci">
<h3>Drop into your workflow (1 job)</h3>
<pre class="good"><button class="copy-btn" data-target="snip-circleci">copy</button><code id="snip-circleci">version: 2.1
jobs:
ci-audit:
docker:
- image: cimg/node:20.10
steps:
- checkout
- run:
name: ci-doctor
command: npx --yes circleci-ci-doctor --markdown
no_output_timeout: 2m
workflows:
audit:
jobs: [ci-audit]</code></pre>
<p>Other useful pages: <a href="/circleci-ci-doctor.html">circleci-ci-doctor docs</a> ·
<a href="/scan-circleci.html">scan in browser</a>.</p>
</div>
<h2>Step 2. Push and look at the output</h2>
<p>
On the next CI run, ci-doctor will print a Markdown table of
findings (and write a SARIF file on GitHub if you used the
Action). On the GitHub side, you also get a sticky PR comment
that updates on every push - no comment-spam.
</p>
<h2>Step 3. (Optional) Lock it in</h2>
<ol class="steps">
<li>Add <code>ci-doctor</code> to your <strong>required checks</strong>
so it gates merges. Start with <code>severity-threshold: error</code>
to avoid blocking on warnings.</li>
<li>Set <code>--baseline</code> against the current report so you
only get failures on <em>new</em> findings (great for legacy
repos).</li>
<li>Embed the <a href="/scan-badge.html">live ci-doctor badge</a>
in your README to show your hygiene score publicly.</li>
</ol>
<div class="cta">
<h3>Need more than the free CLI?</h3>
<p>
The CLI is free forever. The optional <strong>Pro tier</strong>
($5/mo) adds per-org rule overrides, Slack/Webhook delivery of
the weekly digest, the hosted GitHub App with one-click install,
and priority support on issues.
</p>
<a class="btn primary" href="/sponsor.html">Pro tier ($5/mo) →</a>
<a class="btn" href="/depmedic-bot.html">GitHub App (hosted)</a>
<a class="btn" href="https://github.com/sponsors/depmedicdev-byte">Just say thanks</a>
</div>
<h2>What did I just install?</h2>
<p>
<code>ci-doctor</code> is a small Node CLI (no native deps) that
parses your workflow YAML, runs 16 rules against the AST, and
prints a report. It does <em>not</em> phone home, does <em>not</em>
collect telemetry, and does <em>not</em> require any auth tokens
(the Action only needs <code>GITHUB_TOKEN</code>, scoped to PR
comments + SARIF upload).
</p>
<p>
Source: <a href="https://github.com/depmedicdev-byte/ci-doctor">github.com/depmedicdev-byte/ci-doctor</a>
(MIT) ·
<a href="https://www.npmjs.com/package/ci-doctor">npmjs.com/package/ci-doctor</a> ·
<a href="/alternatives.html">how it compares to actionlint / zizmor / octoscan / super-linter</a>.
</p>
<h2>Frequently-skipped questions</h2>
<h3>Does it support self-hosted runners?</h3>
<p>Yes - the audit runs against the workflow YAML, regardless of where
the runner lives. <a href="/runners.html">See our self-hosted runner playbook</a>.</p>
<h3>Does it support reusable workflows?</h3>
<p>Yes - it follows <code>uses:</code> references and audits the
referenced workflow if it lives in the same repo. Cross-repo references
are flagged for manual review.</p>
<h3>Does it work in monorepos?</h3>
<p>Yes - point it at a directory and it audits every workflow file under
it (including nested <code>.github/workflows/</code> trees from packages
inside the monorepo).</p>
<h3>I don't see an issue I expected to see flagged.</h3>
<p>File a GitHub issue with a minimal reproducing snippet. Same-day
response on most bugs.
<a href="https://github.com/depmedicdev-byte/ci-doctor/issues/new">Open an issue →</a></p>
<h3>Have a usage question instead of a bug?</h3>
<p>Browse or ask in
<a href="https://github.com/depmedicdev-byte/ci-doctor/discussions">GitHub Discussions</a>.
Common topics already answered: setup, monorepos, reusable workflows,
how it compares to other linters.</p>
<footer>
<a href="/">depmedic</a> · built and maintained by depmedic.
See also: <a href="/leaderboard.html">leaderboard</a> ·
<a href="/alternatives.html">vs other tools</a> ·
<a href="/scan-badge.html">badge service</a>.
</footer>
<script>
document.querySelectorAll('.tab').forEach((btn) => {
btn.addEventListener('click', () => {
document.querySelectorAll('.tab').forEach((b) => b.classList.remove('active'));
document.querySelectorAll('.panel').forEach((p) => p.classList.remove('active'));
btn.classList.add('active');
document.getElementById('panel-' + btn.dataset.tab).classList.add('active');
});
});
document.querySelectorAll('.copy-btn').forEach((btn) => {
btn.addEventListener('click', () => {
const t = document.getElementById(btn.dataset.target);
navigator.clipboard.writeText(t.innerText.trim());
const orig = btn.innerText;
btn.innerText = 'copied!';
setTimeout(() => { btn.innerText = orig; }, 1200);
});
});
</script>
</main>
</body>
</html>