Skip to content

Commit 8117662

Browse files
shenxianpengshenxianpeng
committed
feat: support versions
1 parent 623f6d7 commit 8117662

6 files changed

Lines changed: 182 additions & 7 deletions

File tree

‎config.yaml‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,11 @@ languages:
3232
url: '#specification'
3333
- label: Contribute
3434
url: 'https://github.com/devops-maturity/spec'
35-
# versions:
36-
# current: v1.0.0
35+
versions:
36+
current: v1.0.0
37+
list:
38+
- v1.0.0
39+
- v1.0.0-next
3740
zh:
3841
params:
3942
weight: 2
@@ -47,3 +50,8 @@ languages:
4750
url: '#规范'
4851
- label: 贡献
4952
url: 'https://github.com/devops-maturity/spec'
53+
versions:
54+
current: v1.0.0
55+
list:
56+
- v1.0.0
57+
- v1.0.0-next

‎content/next/index.md‎

Lines changed: 167 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,167 @@
1+
---
2+
draft: true
3+
---
4+
5+
# DevOps Maturity Specification 1.0.0-next
6+
7+
## Summary
8+
9+
DevOps Maturity Specification provides guidelines for DevOps best practices, aiming to enhance collaboration, automation, and efficiency across software development and operations.
10+
11+
## Key Points
12+
13+
- **Purpose**: Help organizations and teams assess DevOps practices, align on best practices, and drive continuous improvement.
14+
- **Scope**: Covers key DevOps domains including build, testing, security, supply chain, analysis, and reporting.
15+
- **Maturity Levels**: Tracks progress with clear visual badges (See [Badge Levels](#badge-levels)) to provide an easy and intuitive overview.
16+
- **Scoring**: Criteria are weighted as MUST (🟢) or NICE (🟡) enabling clear and actionable evaluation.
17+
- **Tooling**: Works with [devops-maturity](https://github.com/devops-maturity/devops-maturity) to automate scoring via Web UI or CLI.
18+
19+
---
20+
21+
## Specification
22+
23+
| **Category** | **Code**| **Criteria** |**Req.**|
24+
|--------------------|----------|------------------------------------------------------------|--------|
25+
| Basics | D101 | [Branch Builds](#d101-branch-builds) | 🟢 |
26+
| | D102 | [Pull Request Builds](#d102-pull-request-builds) | 🟢 |
27+
| | D103 | [Clean Build Environments](#d103-clean-build-environments) | 🟡 |
28+
| Quality | D201 | [Unit Testing](#d201-unit-testing) | 🟢 |
29+
| | D202 | [Functional Testing](#d202-functional-testing) | 🟢 |
30+
| | D203 | [Performance Testing](#d203-performance-testing) | 🟡 |
31+
| | D204 | [Code Coverage](#d204-code-coverage) | 🟡 |
32+
| | D205 | [Accessibility Testing](#d205-accessibility-testing) | 🟡 |
33+
| Security | D301 | [Security Scanning](#d301-security-scanning) | 🟢 |
34+
| | D302 | [License Scanning](#d302-license-scanning) | 🟡 |
35+
| Supply Chain Security| D401 | [Documented Build Process](#d401-documented-build-process) | 🟢 |
36+
| | D402 | [CI/CD as Code](#d402-ci-cd-as-code) | 🟢 |
37+
| | D403 | [Artifact Signing](#d403-artifact-signing) | 🟡 |
38+
| | D404 | [Dependency Pinning](#d404-dependency-pinning) | 🟡 |
39+
| Analysis | D501 | [Static Code Analysis](#d501-static-code-analysis) | 🟡 |
40+
| | D502 | [Dynamic Code Analysis](#d502-dynamic-code-analysis) | 🟡 |
41+
| | D503 | [Code Linting](#d503-code-linting) | 🟡 |
42+
| Reporting | D601 | [Notifications & Alerts](#d601-notifications--alerts) | 🟢 |
43+
| | D602 | [Attached Reports](#d602-attached-reports) | 🟢 |
44+
45+
- 🟢 MUST have (weight 1)
46+
- 🟡 NICE have (weight 0.5)
47+
48+
## Badge Levels
49+
50+
Your score will generate one of the following badges:
51+
52+
| Level | Score Range | Badge |
53+
|---------|-------------| ------|
54+
| WIP | 0% | ![WIP](https://img.shields.io/badge/DevOps%20Maturity-WIP-red.svg) |
55+
| PASSING | 1–49% | ![PASSING](https://img.shields.io/badge/DevOps%20Maturity-PASSING-green.svg) |
56+
| BRONZE | 50–69% | ![BRONZE](https://img.shields.io/badge/DevOps%20Maturity-BRONZE-yellow.svg) |
57+
| SILVER | 70–89% | ![SILVER](https://img.shields.io/badge/DevOps%20Maturity-SILVER-silver.svg) |
58+
| GOLD | 90–100% | ![GOLD](https://img.shields.io/badge/DevOps%20Maturity-GOLD-gold.svg) |
59+
60+
## Criteria Reference
61+
62+
### Code Map
63+
64+
|**Code**|**Description**|
65+
|--------|---------------|
66+
| D1xx | Basics |
67+
| D2xx | Quality |
68+
| D3xx | Security |
69+
| D4xx | Supply Chain Security|
70+
| D5xx | Analysis |
71+
| D6xx | Reporting |
72+
73+
- All criteria codes are prefixed by domain letter (e.g., `D` for DevOps)
74+
- Code format: `DXYZ`
75+
- `D` = Domain (DevOps)
76+
- `X` = Category (e.g., 1: Basics, 2: Quality)
77+
- `YZ` = Criteria number
78+
79+
## Criteria Details
80+
81+
#### D101 Branch Builds
82+
83+
Supports builds from any specific branch, not just the `main` branch.
84+
85+
#### D102 Pull Request Builds
86+
87+
Supports building pull requests (PRs), not limited to direct pushes to branches.
88+
89+
#### D103 Clean Build Environments
90+
91+
Supports building in clean environments, such as containers or virtual machines (VMs).
92+
93+
#### D201 Unit Testing
94+
95+
Supports unit testing, including unit or component-level tests.
96+
97+
#### D202 Functional Testing
98+
99+
Supports functional testing, such as integration or end-to-end (E2E) tests.
100+
101+
#### D203 Performance Testing
102+
103+
Supports performance testing, including load, stress, or throughput testing.
104+
105+
#### D204 Code Coverage
106+
107+
Supports measuring code coverage, including line, branch, or function coverage.
108+
109+
#### D205 Accessibility Testing
110+
111+
Supports accessibility testing for standards compliance, such as WCAG.
112+
113+
#### D301 Security Scanning
114+
115+
Supports security scanning, including SAST (Static Application Security Testing) and DAST (Dynamic Application Security Testing).
116+
117+
#### D302 License Scanning
118+
119+
Supports license scanning using tools like SPDX, FOSSology, or license-checkers.
120+
121+
#### D401 Documented Build Process
122+
123+
Provides a documented build process, including build steps, manifests, or reproducibility details.
124+
125+
#### D402 CI/CD as Code
126+
127+
Supports CI/CD workflows defined as code, such as pipeline-as-code or infrastructure-as-code.
128+
129+
#### D403 Artifact Signing
130+
131+
Supports artifact signing (e.g., with PGP or GPG) to ensure authenticity and integrity.
132+
133+
#### D404 Dependency Pinning
134+
135+
Supports dependency pinning or version locking to ensure reproducible builds.
136+
137+
#### D501 Static Code Analysis
138+
139+
Supports static code analysis tools such as SonarQube, Polaris, or similar.
140+
141+
#### D502 Dynamic Code Analysis
142+
143+
Supports dynamic analysis, including runtime behavior analysis or fuzz testing.
144+
145+
#### D503 Code Linting
146+
147+
Supports code linting using tools like ESLint, Prettier, or pre-commit hooks.
148+
149+
#### D601 Notifications & Alerts
150+
151+
Supports notification systems such as email or Slack alerts.
152+
153+
#### D602 Attached Reports
154+
155+
Supports attaching detailed reports to builds, such as test results or coverage metrics.
156+
157+
---
158+
159+
## FAQ
160+
161+
### What tools can be used to caculate your score?
162+
163+
You can used [devops-maturity](https://github.com/devops-maturity/devops-maturity) which support web UI and CLI to calculate your score automatically.
164+
165+
### What is the difference between OpenSSF Best Practices and DevOps Maturity?
166+
167+
[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.

content/_index.md renamed to content/v1.0.0/index.md

File renamed without changes.

content/_index.zh.md renamed to content/v1.0.0/index.zh.md

File renamed without changes.

‎themes/devops-maturity/README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ params:
2323
current: 1.0.0
2424

2525
welcome:
26-
description: A specification made for write standardized and useful commit messages
26+
description: A specification for DevOps maturity
2727
image: 'https://path-to-image'
2828
actions:
2929
- label: Read the specs

‎themes/devops-maturity/layouts/partials/header.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
<div class="logo"></div>
55
</a>
66
<ul class="header__menu">
7-
<!-- <li class="header__menu-item dropdown"> -->
8-
<!-- <button class="dropdown__label">Versions</button>
7+
<li class="header__menu-item dropdown">
8+
<button class="dropdown__label">Versions</button>
99
<ul class="dropdown__options">
1010
{{ range .Site.Params.Versions.List }}
1111
<li class="dropdown__option"><a href="/{{ $.Site.Language }}/{{ . }}">{{ . }}</a></li>
1212
{{ end }}
13-
</ul> -->
14-
<!-- </li> -->
13+
</ul>
14+
</li>
1515
<li class="header__menu-item dropdown">
1616
<button class="dropdown__label">Languages</button>
1717
<ul class="dropdown__options">

0 commit comments

Comments
 (0)