Skip to content

Commit a3bc9d9

Browse files
github-actions[bot]github-actions[bot]
committed
1 parent 0e6ff0b commit a3bc9d9

4 files changed

Lines changed: 308 additions & 99 deletions

File tree

‎about/index.html‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,21 +64,23 @@ <h1 class="welcome__title">DevOps Maturity</h1>
6464
<main>
6565
<article class="container markdown-body">
6666
<h1 id="about">About</h1>
67-
<p>The DevOps Maturity specification was inspired by <a href="https://github.com/conventional-branch/conventional-branch">Conventional Branch</a>.</p>
67+
<p>The DevOps Maturity specification is standardized to assess the maturity of DevOps practices. It is a set of questions and answers to help you measure and improve your DevOps maturity.</p>
6868
<h2 id="tooling-for-devops-maturity">Tooling for DevOps Maturity</h2>
6969
<ul>
70-
<li><a href="https://pypi.org/project/devops-maturity">devops-maturity</a>: CLI tool for calculating DevOps Maturity score.</li>
70+
<li><a href="https://github.com/devops-maturity/devops-maturity">devops-maturity</a>: Web UI and CLI tool for calculating DevOps Maturity score.</li>
7171
</ul>
7272
<h2 id="projects-using-devops-maturity">Projects Using DevOps Maturity</h2>
7373
<ul>
74-
<li><a href="https://github.com/ansible/metrics-utility/blob/devel/docs/contributing/CONTRIBUTING.md">ansible/metrics-utility</a>: Standalone utility for github.com/ansible/awx.</li>
75-
<li><a href="https://github.com/cuhacking/2025">cuhacking/2025</a>: Flagship platform for cuHacking&rsquo;s 2025 hackathon.</li>
7674
<li><a href="https://github.com/commit-check">commit-check</a>: A free, powerful tool that enforces commit metadata, branch naming, and more.</li>
77-
<li><a href="https://github.com/ZeusAutomacao/DFe.NET">ZeusAutomacao/DFe.NET</a>: Biblioteca em C# para emissão e impressão de NFe, NFCe, MDF-e e CT-e.</li>
7875
<li><em><a href="https://github.com/search?q=devops-maturity.github.io&type=code&p=1">&hellip; and more projects using DevOps Maturity</a>.</em></li>
7976
</ul>
8077
<p><a href="https://github.com/devops-maturity/devops-maturity"><img alt="DevOps Maturity" src="https://img.shields.io/badge/DevOps%20Maturity%20Specification-1.0.0-yellow"></a></p>
8178
<p><em>Want your project on this list?</em> <a href="https://github.com/devops-maturity/spec/pulls">send a pull request</a>.</p>
79+
<h2 id="author">Author</h2>
80+
<p>Created and maintained by <a href="https://shenxianpeng.github.io"><strong>Xianpeng Shen</strong></a>, Senior DevOps Engineer.<br>
81+
Specialized in CI/CD, automation, developer experience, and open-source tooling.<br>
82+
Creator of <a href="https://github.com/cpp-linter">cpp-linter</a>, <a href="https://github.com/commit-check">commit-check</a>, and <a href="https://github.com/conventional-branch">conventional-branch</a>, widely used in both open-source and enterprise environments.<br>
83+
GitHub: <a href="https://github.com/shenxianpeng">@shenxianpeng</a></p>
8284

8385
</article>
8486
</main><footer class="footer">

‎index.html‎

Lines changed: 148 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -80,132 +80,147 @@ <h1 class="welcome__title">DevOps Maturity</h1>
8080
<article class="container markdown-body">
8181
<h1 id="devops-maturity-specification-100">DevOps Maturity Specification 1.0.0</h1>
8282
<h2 id="summary">Summary</h2>
83-
<p>DevOps Maturity Specification is a set of guidelines for DevOps best practices, focusing on improving collaboration, automation, and efficiency in software development and operations.</p>
83+
<p>DevOps Maturity Specification provides guidelines for DevOps best practices, aiming to enhance collaboration, automation, and efficiency across software development and operations.</p>
84+
<h2 id="key-points">Key Points</h2>
85+
<ul>
86+
<li><strong>Purpose</strong>: Help organizations and teams assess DevOps practices, align on best practices, and drive continuous improvement.</li>
87+
<li><strong>Scope</strong>: Covers key DevOps domains including build, testing, security, supply chain, analysis, and reporting.</li>
88+
<li><strong>Maturity Levels</strong>: Tracks progress with clear visual badges (See <a href="/#badge-levels">Badge Levels</a>) to provide an easy and intuitive overview.</li>
89+
<li><strong>Scoring</strong>: Criteria are weighted as MUST (🟢) or NICE (🟡) enabling clear and actionable evaluation.</li>
90+
<li><strong>Tooling</strong>: Works with <a href="https://github.com/devops-maturity/devops-maturity">devops-maturity</a> to automate scoring via Web UI or CLI.</li>
91+
</ul>
8492
<hr>
8593
<h2 id="specification">Specification</h2>
86-
<h3 id="devops-maturity-criteria">DevOps Maturity Criteria</h3>
87-
<p>must have → 🟢
88-
nice to have → 🟡</p>
8994
<table>
9095
<thead>
9196
<tr>
9297
<th><strong>Category</strong></th>
98+
<th><strong>Code</strong></th>
9399
<th><strong>Criteria</strong></th>
94100
<th><strong>Req.</strong></th>
95-
<th><strong>Weight</strong></th>
96101
</tr>
97102
</thead>
98103
<tbody>
99104
<tr>
100-
<td>CI/CD Basic</td>
101-
<td>Build a specific branch</td>
105+
<td>Basics</td>
106+
<td>D101</td>
107+
<td><a href="/#d101-branch-builds">Branch Builds</a></td>
102108
<td>🟢</td>
103-
<td>1</td>
104109
</tr>
105110
<tr>
106111
<td></td>
107-
<td>Build upon pull request</td>
112+
<td>D102</td>
113+
<td><a href="/#d102-pull-request-builds">Pull Request Builds</a></td>
108114
<td>🟢</td>
109-
<td>1</td>
110115
</tr>
111116
<tr>
112117
<td></td>
113-
<td>Build from clean environment</td>
118+
<td>D103</td>
119+
<td><a href="/#d103-clean-build-environments">Clean Build Environments</a></td>
114120
<td>🟡</td>
115-
<td>0.5</td>
116121
</tr>
117122
<tr>
118123
<td>Quality</td>
119-
<td>Automated Testing: Functional testing</td>
124+
<td>D201</td>
125+
<td><a href="/#d201-unit-testing">Unit Testing</a></td>
120126
<td>🟢</td>
121-
<td>1</td>
122127
</tr>
123128
<tr>
124129
<td></td>
125-
<td>Automated Testing: Performance testing</td>
130+
<td>D202</td>
131+
<td><a href="/#d202-functional-testing">Functional Testing</a></td>
126132
<td>🟢</td>
127-
<td>1</td>
128133
</tr>
129134
<tr>
130135
<td></td>
131-
<td>Code Coverage</td>
136+
<td>D203</td>
137+
<td><a href="/#d203-performance-testing">Performance Testing</a></td>
132138
<td>🟡</td>
133-
<td>0.5</td>
134139
</tr>
135140
<tr>
136141
<td></td>
137-
<td>Accessibility Testing</td>
142+
<td>D204</td>
143+
<td><a href="/#d204-code-coverage">Code Coverage</a></td>
144+
<td>🟡</td>
145+
</tr>
146+
<tr>
147+
<td></td>
148+
<td>D205</td>
149+
<td><a href="/#d205-accessibility-testing">Accessibility Testing</a></td>
138150
<td>🟡</td>
139-
<td>0.5</td>
140151
</tr>
141152
<tr>
142153
<td>Security</td>
143-
<td>Security scan</td>
154+
<td>D301</td>
155+
<td><a href="/#d301-security-scanning">Security Scanning</a></td>
144156
<td>🟢</td>
145-
<td>1</td>
146157
</tr>
147158
<tr>
148159
<td></td>
149-
<td>License scan</td>
160+
<td>D302</td>
161+
<td><a href="/#d302-license-scanning">License Scanning</a></td>
150162
<td>🟡</td>
151-
<td>0.5</td>
152163
</tr>
153164
<tr>
154-
<td>Secure Supply Chain</td>
155-
<td>Documented Build Chain</td>
165+
<td>Supply Chain Security</td>
166+
<td>D401</td>
167+
<td><a href="/#d401-documented-build-process">Documented Build Process</a></td>
156168
<td>🟢</td>
157-
<td>1</td>
158169
</tr>
159170
<tr>
160171
<td></td>
161-
<td>CICD as coded</td>
172+
<td>D402</td>
173+
<td><a href="/#d402-ci-cd-as-code">CI/CD as Code</a></td>
162174
<td>🟢</td>
163-
<td>1</td>
164175
</tr>
165176
<tr>
166177
<td></td>
167-
<td>Artifacts are signed</td>
178+
<td>D403</td>
179+
<td><a href="/#d403-artifact-signing">Artifact Signing</a></td>
168180
<td>🟡</td>
169-
<td>0.5</td>
170181
</tr>
171182
<tr>
172183
<td></td>
173-
<td>Artifactory download for Package Managers</td>
184+
<td>D404</td>
185+
<td><a href="/#d404-dependency-pinning">Dependency Pinning</a></td>
174186
<td>🟡</td>
175-
<td>0.5</td>
176187
</tr>
177188
<tr>
178189
<td>Analysis</td>
179-
<td>Quality Gate</td>
190+
<td>D501</td>
191+
<td><a href="/#d501-static-code-analysis">Static Code Analysis</a></td>
180192
<td>🟡</td>
181-
<td>0.5</td>
182193
</tr>
183194
<tr>
184195
<td></td>
185-
<td>Code Lint</td>
196+
<td>D502</td>
197+
<td><a href="/#d502-dynamic-code-analysis">Dynamic Code Analysis</a></td>
186198
<td>🟡</td>
187-
<td>0.5</td>
188199
</tr>
189200
<tr>
190201
<td></td>
191-
<td>Static code analysis</td>
202+
<td>D503</td>
203+
<td><a href="/#d503-code-linting">Code Linting</a></td>
192204
<td>🟡</td>
193-
<td>0.5</td>
194205
</tr>
195206
<tr>
196-
<td></td>
197-
<td>Dynamic code analysis</td>
198-
<td>🟡</td>
199-
<td>0.5</td>
207+
<td>Reporting</td>
208+
<td>D601</td>
209+
<td><a href="/#d601-notifications--alerts">Notifications &amp; Alerts</a></td>
210+
<td>🟢</td>
200211
</tr>
201212
<tr>
202-
<td>Reporting</td>
203-
<td>Email/Slack reporting functionality</td>
213+
<td></td>
214+
<td>D602</td>
215+
<td><a href="/#d602-attached-reports">Attached Reports</a></td>
204216
<td>🟢</td>
205-
<td>1</td>
206217
</tr>
207218
</tbody>
208219
</table>
220+
<ul>
221+
<li>🟢 MUST have (weight 1)</li>
222+
<li>🟡 NICE have (weight 0.5)</li>
223+
</ul>
209224
<h2 id="badge-levels">Badge Levels</h2>
210225
<p>Your score will generate one of the following badges:</p>
211226
<table>
@@ -244,10 +259,97 @@ <h2 id="badge-levels">Badge Levels</h2>
244259
</tr>
245260
</tbody>
246261
</table>
262+
<h2 id="criteria-reference">Criteria Reference</h2>
263+
<h3 id="code-map">Code Map</h3>
264+
<table>
265+
<thead>
266+
<tr>
267+
<th><strong>Code</strong></th>
268+
<th><strong>Description</strong></th>
269+
</tr>
270+
</thead>
271+
<tbody>
272+
<tr>
273+
<td>D1xx</td>
274+
<td>Basics</td>
275+
</tr>
276+
<tr>
277+
<td>D2xx</td>
278+
<td>Quality</td>
279+
</tr>
280+
<tr>
281+
<td>D3xx</td>
282+
<td>Security</td>
283+
</tr>
284+
<tr>
285+
<td>D4xx</td>
286+
<td>Supply Chain Security</td>
287+
</tr>
288+
<tr>
289+
<td>D5xx</td>
290+
<td>Analysis</td>
291+
</tr>
292+
<tr>
293+
<td>D6xx</td>
294+
<td>Reporting</td>
295+
</tr>
296+
</tbody>
297+
</table>
298+
<ul>
299+
<li>All criteria codes are prefixed by domain letter (e.g., <code>D</code> for DevOps)</li>
300+
<li>Code format: <code>DXYZ</code>
301+
<ul>
302+
<li><code>D</code> = Domain (DevOps)</li>
303+
<li><code>X</code> = Category (e.g., 1: Basics, 2: Quality)</li>
304+
<li><code>YZ</code> = Criteria number</li>
305+
</ul>
306+
</li>
307+
</ul>
308+
<h2 id="criteria-details">Criteria Details</h2>
309+
<h4 id="d101-branch-builds">D101 Branch Builds</h4>
310+
<p>Supports builds from any specific branch, not just the <code>main</code> branch.</p>
311+
<h4 id="d102-pull-request-builds">D102 Pull Request Builds</h4>
312+
<p>Supports building pull requests (PRs), not limited to direct pushes to branches.</p>
313+
<h4 id="d103-clean-build-environments">D103 Clean Build Environments</h4>
314+
<p>Supports building in clean environments, such as containers or virtual machines (VMs).</p>
315+
<h4 id="d201-unit-testing">D201 Unit Testing</h4>
316+
<p>Supports unit testing, including unit or component-level tests.</p>
317+
<h4 id="d202-functional-testing">D202 Functional Testing</h4>
318+
<p>Supports functional testing, such as integration or end-to-end (E2E) tests.</p>
319+
<h4 id="d203-performance-testing">D203 Performance Testing</h4>
320+
<p>Supports performance testing, including load, stress, or throughput testing.</p>
321+
<h4 id="d204-code-coverage">D204 Code Coverage</h4>
322+
<p>Supports measuring code coverage, including line, branch, or function coverage.</p>
323+
<h4 id="d205-accessibility-testing">D205 Accessibility Testing</h4>
324+
<p>Supports accessibility testing for standards compliance, such as WCAG.</p>
325+
<h4 id="d301-security-scanning">D301 Security Scanning</h4>
326+
<p>Supports security scanning, including SAST (Static Application Security Testing) and DAST (Dynamic Application Security Testing).</p>
327+
<h4 id="d302-license-scanning">D302 License Scanning</h4>
328+
<p>Supports license scanning using tools like SPDX, FOSSology, or license-checkers.</p>
329+
<h4 id="d401-documented-build-process">D401 Documented Build Process</h4>
330+
<p>Provides a documented build process, including build steps, manifests, or reproducibility details.</p>
331+
<h4 id="d402-cicd-as-code">D402 CI/CD as Code</h4>
332+
<p>Supports CI/CD workflows defined as code, such as pipeline-as-code or infrastructure-as-code.</p>
333+
<h4 id="d403-artifact-signing">D403 Artifact Signing</h4>
334+
<p>Supports artifact signing (e.g., with PGP or GPG) to ensure authenticity and integrity.</p>
335+
<h4 id="d404-dependency-pinning">D404 Dependency Pinning</h4>
336+
<p>Supports dependency pinning or version locking to ensure reproducible builds.</p>
337+
<h4 id="d501-static-code-analysis">D501 Static Code Analysis</h4>
338+
<p>Supports static code analysis tools such as SonarQube, Polaris, or similar.</p>
339+
<h4 id="d502-dynamic-code-analysis">D502 Dynamic Code Analysis</h4>
340+
<p>Supports dynamic analysis, including runtime behavior analysis or fuzz testing.</p>
341+
<h4 id="d503-code-linting">D503 Code Linting</h4>
342+
<p>Supports code linting using tools like ESLint, Prettier, or pre-commit hooks.</p>
343+
<h4 id="d601-notifications--alerts">D601 Notifications &amp; Alerts</h4>
344+
<p>Supports notification systems such as email or Slack alerts.</p>
345+
<h4 id="d602-attached-reports">D602 Attached Reports</h4>
346+
<p>Supports attaching detailed reports to builds, such as test results or coverage metrics.</p>
247347
<hr>
248348
<h2 id="faq">FAQ</h2>
249349
<h3 id="what-tools-can-be-used-to-caculate-your-score">What tools can be used to caculate your score?</h3>
250350
<p>You can used <a href="https://github.com/devops-maturity/devops-maturity">devops-maturity</a> which support web UI and CLI to calculate your score automatically.</p>
351+
<h3 id="what-is-the-difference-between-openssf-best-practices-and-devops-maturity">What is the difference between OpenSSF Best Practices and DevOps Maturity?</h3>
352+
<p><a href="https://www.bestpractices.dev/">OpenSSF Best Practices</a> targets open source projects across the entire software development lifecycle, while DevOps Maturity focuses specifically on DevOps practices applicable to both open source and internal enterprise projects. DevOps Maturity provides both a web UI and a CLI for automatic maturity scoring. In contrast, OpenSSF Best Practices only offers a web-based SaaS and does not support internal deployment.</p>
251353

252354
</article>
253355
</main><footer class="footer">

‎index.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<link>/about/</link>
1313
<pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate>
1414
<guid>/about/</guid>
15-
<description>About The DevOps Maturity specification was inspired by Conventional Branch.&#xA;Tooling for DevOps Maturity devops-maturity: CLI tool for calculating DevOps Maturity score. Projects Using DevOps Maturity ansible/metrics-utility: Standalone utility for github.com/ansible/awx. cuhacking/2025: Flagship platform for cuHacking&amp;rsquo;s 2025 hackathon. commit-check: A free, powerful tool that enforces commit metadata, branch naming, and more. ZeusAutomacao/DFe.NET: Biblioteca em C# para emissão e impressão de NFe, NFCe, MDF-e e CT-e. &amp;hellip; and more projects using DevOps Maturity.</description>
15+
<description>About The DevOps Maturity specification is standardized to assess the maturity of DevOps practices. It is a set of questions and answers to help you measure and improve your DevOps maturity.&#xA;Tooling for DevOps Maturity devops-maturity: Web UI and CLI tool for calculating DevOps Maturity score. Projects Using DevOps Maturity commit-check: A free, powerful tool that enforces commit metadata, branch naming, and more. &amp;hellip; and more projects using DevOps Maturity. Want your project on this list?</description>
1616
</item>
1717
</channel>
1818
</rss>

0 commit comments

Comments
 (0)