Skip to content

Commit 87b908d

Browse files
authored
create web for devops-maturity spec (#1)
* create web for devops-maturity spec * rename to DevOps Maturity * update package-lock.json * fix can not found issue * save changes * update backgroup and font color
1 parent a7e76cc commit 87b908d

54 files changed

Lines changed: 1762 additions & 166 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/CODEOWNERS

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
* @conventional-branch/developers
1+
* @devops-maturity/developers

.github/dependabot.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
version: 2
44
updates:
55
- package-ecosystem: npm
6-
directory: /themes/conventional-branch/
6+
directory: /themes/devops-maturity/
77
schedule:
88
interval: monthly
99
groups:

.github/workflows/main.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ jobs:
6565
if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
6666
with:
6767
personal_token: ${{ secrets.PERSONAL_TOKEN }}
68-
external_repository: conventional-branch/conventional-branch.github.io
68+
external_repository: devops-maturity/devops-maturity.github.io
6969
publish_branch: main
7070
user_name: 'github-actions[bot]'
7171
user_email: 'github-actions[bot]@users.noreply.github.com'

CONTRIBUTING.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,15 @@ Once the website will be compiled, you can see the website visiting `http://loca
3333

3434
## Contributor Behavior
3535

36-
Be kind to one another. We're striving to make Conventional Branch an inclusive environment that's great for first time open-source contributors.
36+
Be kind to one another. We're striving to make DevOps Maturity an inclusive environment that's great for first time open-source contributors.
3737

3838
tldr; we value constructive community interaction, over technical acumen.
3939

4040
## Pull Requests
4141

42-
Conventional Branch use the [GitHub flow](https://guides.github.com/introduction/flow/) as main versioning workflow
42+
DevOps Maturity use the [GitHub flow](https://guides.github.com/introduction/flow/) as main versioning workflow
4343

44-
1. Fork the Conventional Branch repository
44+
1. Fork the DevOps Maturity repository
4545
2. Create a new branch for each feature, fix or improvement
4646
3. Send a pull request from each feature branch to the **master** branch
4747

@@ -50,10 +50,6 @@ pull request for each branch.
5050

5151
This allow us to review and pull in new features or improvements individually.
5252

53-
## Style Guide
54-
55-
All pull requests SHOULD adhere to the [Conventional Branch specification](https://conventionalcommits.org/)
56-
5753
## License
5854

5955
You must agree that your patch will be licensed under the Conventional Commit License, and when we change the license we will assume that you agreed with the change unless you object to the changes in time.

Dockerfile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
FROM node:19.0.0-alpine
22
WORKDIR /src/
3-
COPY ./themes/conventional-branch /src/
3+
COPY ./themes/devops-maturity /src/
44
RUN apk add make
55
RUN npm install
66
RUN npm run build
77

88
FROM jguyomard/hugo-builder:latest
99
COPY ./ /src/
10-
COPY --from=0 /src/ /src/themes/conventional-branch/
10+
COPY --from=0 /src/ /src/themes/devops-maturity/
1111
RUN hugo
1212

1313
FROM nginx:stable

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ serve-site-dev:
1212

1313
compile-assets:
1414
echo "Compiling assets"
15-
cd themes/conventional-branch && npm install && npm run build
15+
cd themes/devops-maturity && npm install && npm run build
1616
echo "Assets compiled"
1717

1818
compile-assets-dev:
1919
echo "Compiling assets"
20-
cd themes/conventional-branch && npm install && npm run start &
20+
cd themes/devops-maturity && npm install && npm run start &

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
1-
# The Conventional Branch Specification
1+
# The DevOps Maturity Specification
22

3-
[![Conventional Branch](https://img.shields.io/badge/Conventional%20Branch-1.0.0-blue)](https://github.com/conventional-branch/conventional-branch)
3+
[![DevOps Maturity](https://img.shields.io/badge/Conventional%20Branch-1.0.0-blue)](https://github.com/devops-maturity/devops-maturity)
44
![Website](https://img.shields.io/website?url=https%3A%2F%2Fconventional-branch.github.io%2F)
55

6-
The Conventional Branch specification defines a naming convention that brings order to your development workflow — whether you're working solo or with a team.
6+
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.
77

88
## 🎉 Show Your Support
99

10-
If you find this useful, consider giving it a ⭐️ on [GitHub](https://github.com/conventional-branch/conventional-branch)! Your support helps others discover and adopt the spec.
10+
If you find this useful, consider giving it a ⭐️ on [GitHub](https://github.com/devops-maturity/specification)! Your support helps others discover and adopt the spec.
1111

1212
## 🛡 Badges!
1313

14-
Let others know your project follows the Conventional Branch spec. Add this badge to your repository README:
14+
Let others know your project follows the DevOps Maturity spec. Add this badge to your repository README:
1515

1616
```markdown
17-
[![Conventional Branch](https://img.shields.io/badge/Conventional%20Branch-1.0.0-blue)](https://github.com/conventional-branch/conventional-branch)
17+
[![DevOps Maturity](https://img.shields.io/badge/Conventional%20Branch-1.0.0-blue)](https://github.com/devops-maturity/specification)
1818
```
1919

2020
## 🙏 Acknowledgments
2121

22-
Big thanks to [Conventional Commits](https://github.com/conventional-commits/conventionalcommits.org) for inspiring this project with their awesome work.
22+
The DevOps Maturity specification was inspired by [Conventional Branch](https://github.com/conventional-branch/conventional-branch).

config.yaml

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
baseURL: '/'
22
languageCode: en-us
3-
theme: conventional-branch
3+
theme: devops-maturity
44
# defaultContentLanguageInSubdir: true
55
defaultContentLanguage: "en"
66

@@ -15,35 +15,35 @@ params:
1515
footer:
1616
logos:
1717
- name: github
18-
url: 'https://github.com/conventional-branch/conventional-branch'
18+
url: 'https://github.com/devops-maturity/specification'
1919

2020
# Languages parameters
2121
languages:
2222
en:
2323
params:
2424
weight: 1
2525
languageName: "English"
26-
title: Conventional Branch
27-
description: A specification for adding human and machine readable meaning to branch
26+
title: DevOps Maturity
27+
description: Assesment of DevOps maturity
2828
actions:
2929
- label: Quick Summary
3030
url: '#summary'
3131
- label: Full Specification
3232
url: '#specification'
3333
- label: Contribute
34-
url: 'https://github.com/conventional-branch/conventional-branch'
34+
url: 'https://github.com/devops-maturity/specification'
3535
# versions:
3636
# current: v1.0.0
3737
zh:
3838
params:
3939
weight: 2
4040
languageName: "中文"
41-
title: 约定式分支
42-
description: 一种用于给分支增加人机可读含义的规范
41+
title: DevOps 成熟度
42+
description: DevOps 成熟度评估
4343
actions:
4444
- label: 概述
4545
url: '#概述'
4646
- label: 完整规范
4747
url: '#规范'
4848
- label: 贡献
49-
url: 'https://github.com/conventional-branch/conventional-branch'
49+
url: 'https://github.com/devops-maturity/specification'

content/_index.md

Lines changed: 42 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -4,56 +4,58 @@ aliases: ["/en/"]
44
layout: single
55
---
66

7-
# Conventional Branch 1.0.0
7+
# DevOps Maturity Specification 1.0.0
88

99
## Summary
1010

11-
Conventional Branch refers to a structured and standardized naming convention for Git branches which aims to make branch more readable and actionable. We've suggested some branch prefixes you might want to use but you can also specify your own naming convention. A consistent naming convention makes it easier to identify branches by type.
12-
13-
### Key Points
14-
15-
1. **Purpose-driven Branch Names**: Each branch name clearly indicates its purpose, making it easy for all developers to understand what the branch is for.
16-
2. **Integration with CI/CD**: By using consistent branch names, it can help automated systems (like Continuous Integration/Continuous Deployment pipelines) to trigger specific actions based on the branch type (e.g., auto-deployment from release branches).
17-
3. **Team Collaboration** : It encourages collaboration within teams by making branch purpose explicit, reducing misunderstandings and making it easier for team members to switch between tasks without confusion.
18-
19-
## Specification
20-
21-
### Branch Naming Prefixes
22-
23-
The branch specification by describing with `feature/`, `bugfix/`, `hotfix/`, `release/` and `chore/` and it should be structured as follows:
11+
DevOps Maturity Specification is a set of guidelines for DevOps best practices, focusing on improving collaboration, automation, and efficiency in software development and operations.
2412

2513
---
2614

27-
```
28-
<type>/<description>
29-
```
15+
## Specification
3016

31-
- **main**: The main development branch (e.g., `main`, `master`, or `develop`)
32-
- **feature/**: For new features (e.g., `feature/add-login-page`)
33-
- **bugfix/**: For bug fixes (e.g., `bugfix/fix-header-bug`)
34-
- **hotfix/**: For urgent fixes (e.g., `hotfix/security-patch`)
35-
- **release/**: For branches preparing a release (e.g., `release/v1.2.0`)
36-
- **chore/**: For non-code tasks like dependency, docs updates (e.g., `chore/update-dependencies`)
17+
### DevOps Maturity Criteria
18+
19+
must have → 🟢
20+
nice to have → 🟡
21+
22+
| **Category** | **Criteria** | **Req.** | **Weight** |
23+
|---------------------|--------------------------------------------|----------|------------|
24+
| CI/CD Basic | Build a specific branch | 🟢 | 1 |
25+
| | Build upon pull request | 🟢 | 1 |
26+
| | Build from clean environment | 🟡 | 0.5 |
27+
| Quality | Automated Testing: Functional testing | 🟢 | 1 |
28+
| | Automated Testing: Performance testing | 🟢 | 1 |
29+
| | Code Coverage | 🟡 | 0.5 |
30+
| | Accessibility Testing | 🟡 | 0.5 |
31+
| Security | Security scan | 🟢 | 1 |
32+
| | License scan | 🟡 | 0.5 |
33+
| Secure Supply Chain | Documented Build Chain | 🟢 | 1 |
34+
| | CICD as coded | 🟢 | 1 |
35+
| | Artifacts are signed | 🟡 | 0.5 |
36+
| | Artifactory download for Package Managers | 🟡 | 0.5 |
37+
| Analysis | Quality Gate | 🟡 | 0.5 |
38+
| | Code Lint | 🟡 | 0.5 |
39+
| | Static code analysis | 🟡 | 0.5 |
40+
| | Dynamic code analysis | 🟡 | 0.5 |
41+
| Reporting | Email/Slack reporting functionality | 🟢 | 1 |
42+
43+
44+
## Badge Levels
45+
46+
Your score will generate one of the following badges:
47+
48+
* WIP: 0%
49+
* PASSING: 1–49%
50+
* BRONZE: 50–69%
51+
* SILVER: 70–89%
52+
* GOLD: 90–100%
3753

3854
---
3955

40-
### Basic Rules
41-
42-
1. **Use Lowercase Alphanumeric and Hyphens**: Always use lowercase letters (a-z), numbers (0-9), and hyphens to separate words. Avoid special characters, underscores, or spaces.
43-
2. **No Consecutive or Trailing Hyphens**: Ensure that hyphens are used singly, with no consecutive hyphens (`feature/new--login`) or at the end (`feature/new-login-`).
44-
3. **Keep It Clear and Concise**: The branch name should be descriptive yet concise, clearly indicating the purpose of the work.
45-
4. **Include Ticket Numbers**: If applicable, include the ticket number from your project management tool to make tracking easier. For example, for a ticket `issue-123`, the branch name could be `feature/issue-123-new-login`.
46-
47-
## Conclusion
48-
49-
- **Clear Communication**: The branch name alone provides a clear understanding of its purpose the code change.
50-
- **Automation-Friendly**: Easily hooks into automation processes (e.g., different workflows for `feature`, `release`, etc.).
51-
- **Scalability**: Works well in large teams where many developers are working on different tasks simultaneously.
52-
53-
In summary, conventional branch is designed to improve project organization, communication, and automation within Git workflows.
54-
5556
## FAQ
5657

57-
### What tools can be used to automatically identify if a team member does not meet this specification?
58+
### What tools can be used to caculate your score?
59+
60+
You can used [devops-maturity](https://pypi.org/project/devops-maturity) CLI to caculate your score.
5861

59-
You can used [commit-check](https://github.com/commit-check/commit-check) to check branch specification or [commit-check-action](https://github.com/commit-check/commit-check-action) if your codes are hosted on GitHub.

content/_index.zh.md

Lines changed: 38 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -4,56 +4,51 @@ aliases: ["/zh/"]
44
layout: single
55
---
66

7-
# 约定式分支
7+
# DevOps 成熟度规范
88

99
## 概述
1010

11-
约定式分支是指 Git 分支的结构化和标准化命名约定,旨在使分支更具可读性和可操作性。我们建议了一些您可能想要使用的分支前缀,但您也可以指定自己的命名约定。一致的命名约定使按类型识别分支变得更加容易。
12-
13-
### 要点
14-
15-
1. **以目的为导向的分支名称**:每个分支名称都清楚地表明了其目的,使所有开发人员都能轻松了解该分支的用途。
16-
2. **与 CI/CD 集成**:通过使用一致的分支名称,它可以帮助自动化系统(如持续集成/持续部署管道)根据分支类型触发特定操作(例如,从发布分支自动部署)。
17-
3. **团队协作**:它通过明确分支目的来鼓励团队内部的协作,减少误解并使团队成员更容易在任务之间切换而不会产生混淆。
11+
DevOps 成熟度规范是一套 DevOps 最佳实践指南,旨在提升软件开发与运维的协作、自动化和效率。
1812

1913
## 规范
2014

21-
### 分支命名前缀
22-
23-
分支规范通过 `feature/``bugfix/``hotfix/``release/``chore/` 来描述,其结构应如下:
24-
25-
---
26-
27-
```
28-
<type>/<description>
29-
```
30-
31-
- **main**:主要开发分支(例如 `main``master``develop`
32-
- **feature/**:用于新功能(例如 `feature/add-login-page`
33-
- **bugfix/**:用于错误修复(例如 `bugfix/fix-header-bug`
34-
- **hotfix/**:用于紧急修复(例如 `hotfix/security-patch`
35-
- **release/**:用于准备发布的分支(例如 `release/v1.2.0`
36-
- **chore/**:用于非代码任务,如依赖项、文档更新(例如 `chore/update-dependencies`
37-
38-
---
39-
40-
### 基本规则
41-
42-
1. **使用小写字母、数字和连字符**:分支名称应全部使用小写字母 (a-z)、数字 (0-9) 及连字符 (-) 进行分隔。避免使用特殊字符、下划线或空格。
43-
2. **禁止连续或结尾连字符**:确保连字符不连续使用 (`feature/new--login`),且不出现在名称末尾 (`feature/new-login-`)。
44-
3. **保持清晰简洁**:分支名称应简明扼要,清楚表达工作的内容和目的。
45-
4. **包含工单编号**:如果适用,应包含项目管理工具中的工单编号,以便于追踪。例如,对于工单 `issue-123`,分支名称可以是 `feature/issue-123-new-login`
46-
47-
## 结论
48-
49-
- **清晰的沟通**:仅凭分支名称就能清楚地了解代码更改的目的。
50-
- **自动化友好**:轻松挂接自动化流程(例如,针对 `feature`, `release` 等的不同工作流程)。
51-
- **可扩展性**:适用于许多开发人员同时处理不同任务的大型团队。
52-
53-
总之,约定式分支旨在改善 Git 工作流程中的项目组织、沟通和自动化。
15+
### DevOps 成熟度评估标准
16+
17+
必选 → 🟢  可选 → 🟡
18+
19+
| **类别** | **评估项** | **要求** | **权重** |
20+
|-----------------------|--------------------------------------------|----------|----------|
21+
| CI/CD 基础 | 构建指定分支 | 🟢 | 1 |
22+
| | Pull Request 自动构建 | 🟢 | 1 |
23+
| | 干净环境构建 | 🟡 | 0.5 |
24+
| 质量保障 | 自动化测试:功能测试 | 🟢 | 1 |
25+
| | 自动化测试:性能测试 | 🟢 | 1 |
26+
| | 代码覆盖率 | 🟡 | 0.5 |
27+
| | 可访问性测试 | 🟡 | 0.5 |
28+
| 安全 | 安全扫描 | 🟢 | 1 |
29+
| | 许可证扫描 | 🟡 | 0.5 |
30+
| 供应链安全 | 构建链文档化 | 🟢 | 1 |
31+
| | CICD 流水线代码化 | 🟢 | 1 |
32+
| | 制品签名 | 🟡 | 0.5 |
33+
| | 包管理器制品下载 | 🟡 | 0.5 |
34+
| 分析 | 质量门禁 | 🟡 | 0.5 |
35+
| | 代码风格检查 | 🟡 | 0.5 |
36+
| | 静态代码分析 | 🟡 | 0.5 |
37+
| | 动态代码分析 | 🟡 | 0.5 |
38+
| 报告 | 邮件/Slack 报告功能 | 🟢 | 1 |
39+
40+
## 徽章等级
41+
42+
你的得分将获得以下徽章之一:
43+
44+
* WIP: 0%
45+
* PASSING: 1–49%
46+
* BRONZE: 50–69%
47+
* SILVER: 70–89%
48+
* GOLD: 90–100%
5449

5550
## 常见问题
5651

57-
### 如果团队成员不符合此规范,可以使用哪些工具来自动识别
52+
### 如何计算得分
5853

59-
你可以使用 [commit-check](https://github.com/commit-check/commit-check) 来检查分支规范,或者如果你的代码托管在 GitHub 上,则使用 [commit-check-action](https://github.com/commit-check/commit-check-action)
54+
您可以使用 [devops-maturity](https://pypi.org/project/devops-maturity) CLI 工具自动计算得分

0 commit comments

Comments
 (0)