Skip to content

Commit cdab164

Browse files
committed
feat: update spec
1 parent d593e2b commit cdab164

2 files changed

Lines changed: 136 additions & 50 deletions

File tree

content/_index.md

Lines changed: 129 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -22,32 +22,46 @@ DevOps Maturity Specification provides guidelines for DevOps best practices, aim
2222

2323
## Specification
2424

25-
| **Category** |**Code**| **Criteria** | **Req.**|
26-
|--------------------|--------|----------------------------------|---------|
27-
| Basics | D101 | Branch Builds[^1] | 🟢 |
28-
| | D102 | Pull Request Builds[^2] | 🟢 |
29-
| | D103 | Clean Build Environments[^3] | 🟡 |
30-
| Quality | D201 | Unit Testing[^4] | 🟢 |
31-
| | D202 | Functional Testing[^5] | 🟢 |
32-
| | D203 | Performance Testing[^6] | 🟡 |
33-
| | D204 | Code Coverage[^7] | 🟡 |
34-
| | D205 | Accessibility Testing[^8] | 🟡 |
35-
| Security | D301 | Security Scanning[^9] | 🟢 |
36-
| | D302 | License Scanning[^10] | 🟡 |
37-
| Supply Chain Security| D401 | Documented Build Process[^11] | 🟢 |
38-
| | D402 | CI/CD as Code[^12] | 🟢 |
39-
| | D403 | Artifact Signing[^13] | 🟡 |
40-
| | D404 | Dependency Pinning[^14] | 🟡 |
41-
| Analysis | D501 | Static Code Analysis[^15] | 🟡 |
42-
| | D502 | Dynamic Code Analysis[^16] | 🟡 |
43-
| | D504 | Code Linting[^17] | 🟡 |
44-
| Reporting | D601 | Notifications & Alerts[^18] | 🟢 |
45-
| | D602 | Attached Reports[^19] | 🟢 |
25+
| **Category** | **Code**| **Criteria** |**Req.**|
26+
|--------------------|----------|------------------------------------------------------------|--------|
27+
| Basics | D101 | [Branch Builds](#d101-branch-builds) | 🟢 |
28+
| | D102 | [Pull Request Builds](#d102-pull-request-builds) | 🟢 |
29+
| | D103 | [Clean Build Environments](#d103-clean-build-environments) | 🟡 |
30+
| Quality | D201 | [Unit Testing](#d201-unit-testing) | 🟢 |
31+
| | D202 | [Functional Testing](#d202-functional-testing) | 🟢 |
32+
| | D203 | [Performance Testing](#d203-performance-testing) | 🟡 |
33+
| | D204 | [Code Coverage](#d204-code-coverage) | 🟡 |
34+
| | D205 | [Accessibility Testing](#d205-accessibility-testing) | 🟡 |
35+
| Security | D301 | [Security Scanning](#d301-security-scanning) | 🟢 |
36+
| | D302 | [License Scanning](#d302-license-scanning) | 🟡 |
37+
| Supply Chain Security| D401 | [Documented Build Process](#d401-documented-build-process) | 🟢 |
38+
| | D402 | [CI/CD as Code](#d402-ci-cd-as-code) | 🟢 |
39+
| | D403 | [Artifact Signing](#d403-artifact-signing) | 🟡 |
40+
| | D404 | [Dependency Pinning](#d404-dependency-pinning) | 🟡 |
41+
| Analysis | D501 | [Static Code Analysis](#d501-static-code-analysis) | 🟡 |
42+
| | D502 | [Dynamic Code Analysis](#d502-dynamic-code-analysis) | 🟡 |
43+
| | D503 | [Code Linting](#d503-code-linting) | 🟡 |
44+
| Reporting | D601 | [Notifications & Alerts](#d601-notifications--alerts) | 🟢 |
45+
| | D602 | [Attached Reports](#d602-attached-reports) | 🟢 |
4646

4747
- 🟢 MUST have (weight 1)
4848
- 🟡 NICE have (weight 0.5)
4949

50-
### Maturity Code Map
50+
## Badge Levels
51+
52+
Your score will generate one of the following badges:
53+
54+
| Level | Score Range | Badge |
55+
|---------|-------------| ------|
56+
| WIP | 0% | ![WIP](https://img.shields.io/badge/DevOps%20Maturity-WIP-red.svg) |
57+
| PASSING | 1–49% | ![PASSING](https://img.shields.io/badge/DevOps%20Maturity-PASSING-green.svg) |
58+
| BRONZE | 50–69% | ![BRONZE](https://img.shields.io/badge/DevOps%20Maturity-BRONZE-yellow.svg) |
59+
| SILVER | 70–89% | ![SILVER](https://img.shields.io/badge/DevOps%20Maturity-SILVER-silver.svg) |
60+
| GOLD | 90–100% | ![GOLD](https://img.shields.io/badge/DevOps%20Maturity-GOLD-gold.svg) |
61+
62+
## Criteria Reference
63+
64+
### Code Map
5165

5266
|**Code**|**Description**|
5367
|--------|---------------|
@@ -64,18 +78,83 @@ DevOps Maturity Specification provides guidelines for DevOps best practices, aim
6478
- `X` = Category (e.g., 1: Basics, 2: Quality)
6579
- `YZ` = Criteria number
6680

81+
## Criteria Details
6782

68-
## Badge Levels
83+
#### D101 Branch Builds
6984

70-
Your score will generate one of the following badges:
85+
Supports builds from any specific branch, not just the `main` branch.
7186

72-
| Level | Score Range | Badge |
73-
|---------|-------------| ------|
74-
| WIP | 0% | ![WIP](https://img.shields.io/badge/DevOps%20Maturity-WIP-red.svg) |
75-
| PASSING | 1–49% | ![PASSING](https://img.shields.io/badge/DevOps%20Maturity-PASSING-green.svg) |
76-
| BRONZE | 50–69% | ![BRONZE](https://img.shields.io/badge/DevOps%20Maturity-BRONZE-yellow.svg) |
77-
| SILVER | 70–89% | ![SILVER](https://img.shields.io/badge/DevOps%20Maturity-SILVER-silver.svg) |
78-
| GOLD | 90–100% | ![GOLD](https://img.shields.io/badge/DevOps%20Maturity-GOLD-gold.svg) |
87+
#### D102 Pull Request Builds
88+
89+
Supports building pull requests (PRs), not limited to direct pushes to branches.
90+
91+
#### D103 Clean Build Environments
92+
93+
Supports building in clean environments, such as containers or virtual machines (VMs).
94+
95+
#### D201 Unit Testing
96+
97+
Supports unit testing, including unit or component-level tests.
98+
99+
#### D202 Functional Testing
100+
101+
Supports functional testing, such as integration or end-to-end (E2E) tests.
102+
103+
#### D203 Performance Testing
104+
105+
Supports performance testing, including load, stress, or throughput testing.
106+
107+
#### D204 Code Coverage
108+
109+
Supports measuring code coverage, including line, branch, or function coverage.
110+
111+
#### D205 Accessibility Testing
112+
113+
Supports accessibility testing for standards compliance, such as WCAG.
114+
115+
#### D301 Security Scanning
116+
117+
Supports security scanning, including SAST (Static Application Security Testing) and DAST (Dynamic Application Security Testing).
118+
119+
#### D302 License Scanning
120+
121+
Supports license scanning using tools like SPDX, FOSSology, or license-checkers.
122+
123+
#### D401 Documented Build Process
124+
125+
Provides a documented build process, including build steps, manifests, or reproducibility details.
126+
127+
#### D402 CI/CD as Code
128+
129+
Supports CI/CD workflows defined as code, such as pipeline-as-code or infrastructure-as-code.
130+
131+
#### D403 Artifact Signing
132+
133+
Supports artifact signing (e.g., with PGP or GPG) to ensure authenticity and integrity.
134+
135+
#### D404 Dependency Pinning
136+
137+
Supports dependency pinning or version locking to ensure reproducible builds.
138+
139+
#### D501 Static Code Analysis
140+
141+
Supports static code analysis tools such as SonarQube, Polaris, or similar.
142+
143+
#### D502 Dynamic Code Analysis
144+
145+
Supports dynamic analysis, including runtime behavior analysis or fuzz testing.
146+
147+
#### D503 Code Linting
148+
149+
Supports code linting using tools like ESLint, Prettier, or pre-commit hooks.
150+
151+
#### D601 Notifications & Alerts
152+
153+
Supports notification systems such as email or Slack alerts.
154+
155+
#### D602 Attached Reports
156+
157+
Supports attaching detailed reports to builds, such as test results or coverage metrics.
79158

80159
---
81160

@@ -89,22 +168,22 @@ You can used [devops-maturity](https://github.com/devops-maturity/devops-maturit
89168

90169
[OpenSSF Best Practices](https://www.bestpractices.dev/) 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.
91170

92-
[^1]: Supports builds from any specific branch, not just the `main` branch.
93-
[^2]: Supports building pull requests (PRs), not limited to direct pushes to branches.
94-
[^3]: Supports building in clean environments, such as containers or virtual machines (VMs).
95-
[^4]: Supports unit testing, including unit or component-level tests.
96-
[^5]: Supports functional testing, such as integration or end-to-end (E2E) tests.
97-
[^6]: Supports performance testing, including load, stress, or throughput testing.
98-
[^7]: Supports measuring code coverage, including line, branch, or function coverage.
99-
[^8]: Supports accessibility testing for standards compliance, such as WCAG.
100-
[^9]: Supports security scanning, including SAST (Static Application Security Testing) and DAST (Dynamic Application Security Testing).
101-
[^10]: Supports license scanning using tools like SPDX, FOSSology, or license-checkers.
102-
[^11]: Provides a documented build process, including build steps, manifests, or reproducibility details.
103-
[^12]: Supports CI/CD workflows defined as code, such as pipeline-as-code or infrastructure-as-code.
104-
[^13]: Supports artifact signing (e.g., with PGP or GPG) to ensure authenticity and integrity.
105-
[^14]: Supports dependency pinning or version locking to ensure reproducible builds.
106-
[^15]: Supports static code analysis tools such as SonarQube, Polaris, or similar.
107-
[^16]: Supports dynamic analysis, including runtime behavior analysis or fuzz testing.
108-
[^17]: Supports code linting using tools like ESLint, Prettier, or pre-commit hooks.
109-
[^18]: Supports notification systems such as email or Slack alerts.
110-
[^19]: Supports attaching detailed reports to builds, such as test results or coverage metrics.
171+
<!-- [^1]: D101: Supports builds from any specific branch, not just the `main` branch.
172+
[^2]: D102: Supports building pull requests (PRs), not limited to direct pushes to branches.
173+
[^3]: D103: Supports building in clean environments, such as containers or virtual machines (VMs).
174+
[^4]: D104: Supports unit testing, including unit or component-level tests.
175+
[^5]: D105: Supports functional testing, such as integration or end-to-end (E2E) tests.
176+
[^6]: D106: Supports performance testing, including load, stress, or throughput testing.
177+
[^7]: D107: Supports measuring code coverage, including line, branch, or function coverage.
178+
[^8]: D108: Supports accessibility testing for standards compliance, such as WCAG.
179+
[^9]: D109: Supports security scanning, including SAST (Static Application Security Testing) and DAST (Dynamic Application Security Testing).
180+
[^10]: D110: Supports license scanning using tools like SPDX, FOSSology, or license-checkers.
181+
[^11]: D111: Provides a documented build process, including build steps, manifests, or reproducibility details.
182+
[^12]: D112: Supports CI/CD workflows defined as code, such as pipeline-as-code or infrastructure-as-code.
183+
[^13]: D113: Supports artifact signing (e.g., with PGP or GPG) to ensure authenticity and integrity.
184+
[^14]: D114: Supports dependency pinning or version locking to ensure reproducible builds.
185+
[^15]: D115: Supports static code analysis tools such as SonarQube, Polaris, or similar.
186+
[^16]: D116: Supports dynamic analysis, including runtime behavior analysis or fuzz testing.
187+
[^17]: D117: Supports code linting using tools like ESLint, Prettier, or pre-commit hooks.
188+
[^18]: D118: Supports notification systems such as email or Slack alerts.
189+
[^19]: D119: Supports attaching detailed reports to builds, such as test results or coverage metrics. -->

content/about/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,3 +19,10 @@ The DevOps Maturity specification is standardized to assess the maturity of DevO
1919
[![DevOps Maturity](https://img.shields.io/badge/DevOps%20Maturity%20Specification-1.0.0-yellow)](https://github.com/devops-maturity/devops-maturity)
2020

2121
_Want your project on this list?_ [send a pull request](https://github.com/devops-maturity/spec/pulls).
22+
23+
## Author
24+
25+
Created and maintained by [**Xianpeng Shen**](https://shenxianpeng.github.io), Senior DevOps Engineer.
26+
Specialized in CI/CD, automation, developer experience, and open-source tooling.\
27+
Creator of [cpp-linter](https://github.com/cpp-linter), [commit-check](https://github.com/commit-check), and [conventional-branch](https://github.com/conventional-branch), widely used in both open-source and enterprise environments.\
28+
GitHub: [@shenxianpeng](https://github.com/shenxianpeng)

0 commit comments

Comments
 (0)