-
-
Notifications
You must be signed in to change notification settings - Fork 302
docs(third-party): separate providers and template docs #1664
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| # What are third-party plugins? | ||
|
|
||
| Third-party plugins are a way to extend Commitizen with additional customized features. | ||
|
|
||
| These plugins are available as PyPI packages (installable with `pip`). | ||
|
|
||
| !!! note | ||
| New plugins are welcome! Once you published your plugins, please send us a PR to update this page. | ||
|
|
||
| !!! note "Historical notes" | ||
| This section was originally called "Third-Party Commitizen Templates", but has been renamed to "Third-Party Commitizen Plugins" to better reflect the content. | ||
|
|
||
| ## Plugin features | ||
|
|
||
| <!-- TODO: provide more details about the features --> | ||
| <!-- We can move the details from customization pages to here --> | ||
|
|
||
| ### Commit message convention | ||
|
|
||
| Includes the rules to validate and generate commit messages. | ||
|
|
||
| ### Version scheme | ||
|
|
||
| Includes the rules to generate version numbers. | ||
|
|
||
| ### Version provider | ||
|
|
||
| Read and write version from data sources. | ||
|
|
||
| ### Changelog format | ||
|
|
||
| Generate changelog in customized formats. | ||
|
|
||
| <!-- TODO: complete the following section --> | ||
| <!-- ## How do I create a new plugin? --> | ||
|
|
||
| ## How to help us update the list of plugins? | ||
|
|
||
| Please document what features the plugin provides: | ||
|
|
||
| - a convention | ||
| - a scheme | ||
| - a provider | ||
| - a `changelog_format` | ||
|
|
||
| Of course, a plugin can provide multiple features. | ||
| You may have noticed that `commitizen` itself can be viewed as a plugin that provides all the above features. | ||
|
|
||
| Please see [cz-path](./cz-path.md) for a detailed example. | ||
|
|
||
| ## New plugin documentation template | ||
|
|
||
| # [Package name](https://github.com/author/package-name) | ||
|
|
||
| <!-- Description of the plugin. --> | ||
|
|
||
| <!-- What features does the plugin provide? --> | ||
|
|
||
| ## Installation | ||
|
|
||
| ```sh | ||
| pip install package-name | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| ```sh | ||
| cz --name package-name commit | ||
| ``` | ||
|
|
||
| ## Example | ||
|
|
||
| <!-- Example usage of the plugin. --> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # [commitizen-deno-provider](https://pypi.org/project/commitizen-deno-provider/) | ||
|
|
||
| A provider for **Deno** projects. The provider updates the version in `deno.json` and `jsr.json` files. | ||
|
|
||
| <!-- TODO: What features does the plugin provide? --> | ||
|
|
||
| ## Installation | ||
|
|
||
| ```sh | ||
| pip install commitizen-deno-provider | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| Add `deno-provider` to your configuration file. | ||
|
|
||
| Example for `.cz.yaml`: | ||
|
|
||
| ```yaml | ||
| --- | ||
| commitizen: | ||
| major_version_zero: true | ||
| name: cz_conventional_commits | ||
| tag_format: $version | ||
| update_changelog_on_bump: true | ||
| version_provider: deno-provider | ||
| version_scheme: semver | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # [Commitizen emoji](https://pypi.org/project/commitizen-emoji/) (Unmaintained) | ||
|
|
||
| Just like *conventional commit* format, but with emojis and optionally time spent and related tasks. | ||
|
|
||
| <!-- TODO: What features does the plugin provide? --> | ||
|
|
||
| ## Installation | ||
|
|
||
| ```sh | ||
| pip install commitizen-emoji | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| ```sh | ||
| cz --name cz_commitizen_emoji commit | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # [Conventional JIRA](https://pypi.org/project/conventional-JIRA/) | ||
|
|
||
| Just like _conventional commit_ format, but the scope has been restricted to a | ||
| JIRA issue format, i.e. `project-issueNumber`. This standardises scopes in a | ||
| meaningful way. | ||
|
|
||
| <!-- TODO: What features does the plugin provide? --> | ||
|
|
||
| ## Installation | ||
|
|
||
| ```sh | ||
| pip install conventional-JIRA | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # [cz-ai](https://github.com/watadarkstar/cz_ai) | ||
|
|
||
| A Commitizen plugin that leverages OpenAI's GPT-4o to automatically generate clear, concise, and conventional commit messages based on your staged git changes. | ||
|
|
||
| <!-- TODO: What features does the plugin provide? --> | ||
|
|
||
| ## Installation | ||
|
|
||
| ```sh | ||
| pip install cz-ai | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| ```sh | ||
| cz --name cz_ai commit | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # [cz-conventional-gitmoji](https://github.com/ljnsn/cz-conventional-gitmoji) | ||
|
|
||
| *conventional commit*s, but with [gitmojis](https://gitmoji.dev). | ||
|
|
||
| Includes a pre-commit hook that automatically adds the correct gitmoji to the commit message based on the conventional type. | ||
|
|
||
| <!-- TODO: What features does the plugin provide? --> | ||
|
|
||
| ## Installation | ||
|
|
||
| ```sh | ||
| pip install cz-conventional-gitmoji | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| ```sh | ||
| cz --name cz_gitmoji commit | ||
| ``` |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.