Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
171 lines (164 loc) · 7.38 KB
/
Copy pathmkdocs.yml
File metadata and controls
171 lines (164 loc) · 7.38 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
site_name: Commitizen
site_url: https://commitizen-tools.github.io/commitizen/
site_description: commit rules, semantic version, conventional commits
theme:
name: material
logo: images/cz_logo.png
favicon: images/cz_logo.png
features:
- content.code.copy
palette:
# Palette toggle for automatic mode
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
# Palette toggle for light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: deep purple
toggle:
icon: material/brightness-7
name: Switch to dark mode
# Palette toggle for dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: deep purple
toggle:
icon: material/brightness-4
name: Switch to system preference
repo_name: commitizen-tools/commitizen
repo_url: https://github.com/commitizen-tools/commitizen
edit_uri: ""
nav:
- Introduction: "README.md"
- Commands:
- init: "commands/init.md"
- commit: "commands/commit.md"
- bump: "commands/bump.md"
- check: "commands/check.md"
- changelog: "commands/changelog.md"
- example: "commands/example.md"
- info: "commands/info.md"
- ls: "commands/ls.md"
- schema: "commands/schema.md"
- version: "commands/version.md"
- Configuration:
- Configuration File: "config/configuration_file.md"
- General: "config/option.md"
- bump: "config/bump.md"
- commit: "config/commit.md"
- check: "config/check.md"
- changelog: "config/changelog.md"
- Version Provider: "config/version_provider.md"
- Advanced Customization:
- Customize via config file: "customization/config_file.md"
- Customized Python Class: "customization/python_class.md"
- Changelog Template: "customization/changelog_template.md"
- Tutorials:
- Commit Message Best Practices: "tutorials/writing_commits.md"
- Managing tags formats: "tutorials/tag_format.md"
- Auto check commits: "tutorials/auto_check.md"
- Auto prepare commit message: "tutorials/auto_prepare_commit_message.md"
- GitLab CI: "tutorials/gitlab_ci.md"
- GitHub Actions: "tutorials/github_actions.md"
- Jenkins pipeline: "tutorials/jenkins_pipeline.md"
- Developmental releases: "tutorials/dev_releases.md"
- Monorepo support: "tutorials/monorepo_guidance.md"
- Release with SCM Version Provider: "tutorials/release-scm.md"
- FAQ: "faq.md"
- "features_wont_add.md"
- Exit Codes: "exit_codes.md"
- Third-Party Commitizen Plugins:
- About: "third-party-plugins/about.md"
# Please sort the plugins alphabetically
- "third-party-plugins/commitizen-deno-provider.md"
- "third-party-plugins/commitizen-emoji.md"
- "third-party-plugins/commitizen-galaxy-provider.md"
- "third-party-plugins/conventional-jira.md"
- "third-party-plugins/cz-ai.md"
- "third-party-plugins/cz-conventional-gitmoji.md"
- "third-party-plugins/cz-emoji.md"
- "third-party-plugins/cz-legacy.md"
- "third-party-plugins/cz-path.md"
- "third-party-plugins/github-jira-conventional.md"
- Contributing:
- "contributing/contributing_tldr.md"
- "contributing/contributing.md"
- "contributing/pull_request.md"
- "history.md"
- Resources: "external_links.md"
markdown_extensions:
- markdown.extensions.codehilite:
guess_lang: false
- admonition
- codehilite
- extra
- pymdownx.highlight
- pymdownx.superfences
- toc:
permalink: true
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
plugins:
- search
- git-revision-date-localized
- llmstxt:
full_output: llms-full.txt
markdown_description: >
Commitizen is a release management tool for teams that enforce
Conventional Commits, automate semantic versioning bumps, and
generate changelogs. Start with the introduction for installation
and core workflows, then use the command and configuration sections
for day-to-day usage. Tutorials cover CI integration, commit hooks,
monorepos, and release automation.
sections:
Overview:
- README.md
- faq.md: Answers to common setup and usage questions.
- exit_codes.md: Reference for Commitizen CLI exit codes and failure modes.
Commands:
- commands/init.md: Initialize Commitizen configuration for a project.
- commands/commit.md: Create standardized commits with the interactive prompt.
- commands/bump.md: Calculate next version, update version files, and manage release tagging.
- commands/check.md: Validate commit messages against the configured convention.
- commands/changelog.md: Generate changelog entries from commits and tags.
- commands/example.md: Show example commit messages for the configured rules.
- commands/info.md: Show information about the active configuration.
- commands/ls.md: List supported commit message choices for the active rules.
- commands/schema.md: Show the commit message schema for the active convention.
- commands/version.md: Show the installed or project version.
Configuration:
- config/configuration_file.md: Where configuration can live and how it is loaded.
- config/option.md: Global options such as commit rules, version, and style.
- config/bump.md: Version bumping, tag creation, and version-file update settings.
- config/commit.md: Settings for interactive commit creation and prompts.
- config/check.md: Settings for commit message validation.
- config/changelog.md: Settings for changelog generation and formatting.
- config/version_provider.md: How Commitizen reads and writes versions for different project types.
Advanced Customization:
- customization/config_file.md: Define custom commit and bump rules in project configuration.
- customization/python_class.md: Implement a Python class for fully custom behavior.
- customization/changelog_template.md: Customize changelog output templates.
Tutorials:
- tutorials/writing_commits.md: Writing effective Conventional Commits.
- tutorials/tag_format.md: Configure and work with custom Git tag formats.
- tutorials/auto_check.md: Enforce commit message checks automatically.
- tutorials/auto_prepare_commit_message.md: Pre-fill commit messages before editing.
- tutorials/gitlab_ci.md: Automate release workflows in GitLab CI.
- tutorials/github_actions.md: Automate release workflows in GitHub Actions.
- tutorials/jenkins_pipeline.md: Integrate Commitizen into Jenkins pipelines.
- tutorials/dev_releases.md: Manage development and prerelease versioning.
- tutorials/monorepo_guidance.md: Configure Commitizen for monorepos.
Third-Party Plugins:
- third-party-plugins/about.md: Overview of the plugin ecosystem.
- third-party-plugins/*.md
Contributing:
- contributing/contributing_tldr.md: Fast path for setting up a local dev workflow.
- contributing/contributing.md: Full contributor guide.
- contributing/pull_request.md: Expectations for preparing and submitting PRs.