Skip to content
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

docs(third-party-commitizen): add commitizen-deno-provider #1259

Merged
merged 3 commits into from
Oct 16, 2024
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 34 additions & 6 deletions docs/third-party-commitizen.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ are available as PyPI packages (installable with `pip`).

### [Conventional JIRA](https://pypi.org/project/conventional-JIRA/)

Just like *conventional commit* format, but the scope has been restricted to a
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.

Expand All @@ -18,6 +18,7 @@ pip install conventional-JIRA
### [GitHub JIRA Conventional](https://pypi.org/project/cz-github-jira-conventional/)

This plugin extends the commitizen tools by:

- requiring a JIRA issue id in the commit message
- creating links to GitHub commits in the CHANGELOG.md
- creating links to JIRA issues in the CHANGELOG.md
Expand All @@ -32,7 +33,7 @@ For installation instructions (configuration and pre-commit) please visit https:

### [cz-emoji](https://github.com/adam-grant-hendry/cz-emoji)

*conventional commit* format, but with emojis
_conventional commit_ format, but with emojis

### Installation

Expand Down Expand Up @@ -64,23 +65,50 @@ pip install cz-conventional-gitmoji
cz --name cz_gitmoji commit
```


### [Commitizen emoji](https://pypi.org/project/commitizen-emoji/) (Unmaintained)

Just like *conventional commit* format, but with emojis and optionally time spent and related tasks.
Just like _conventional commit_ format, but with emojis and optionally time spent and related tasks.

It can be installed with `pip install commitizen-emoji`.

Usage: `cz --name cz_commitizen_emoji commit`.

### [Conventional Legacy (cz_legacy)][1]

An extension of the *conventional commit* format to include user-specified
An extension of the _conventional commit_ format to include user-specified
legacy change types in the `CHANGELOG` while preventing the legacy change types
from being used in new commit messages

`cz_legacy` can be installed with `pip install cz_legacy`

See the [README][1] for instructions on configuration

[1]: https://pypi.org/project/cz_legacy
[1]: https://pypi.org/project/cz_legacy

### [commitizen-deno-provider](https://pypi.org/project/commitizen-deno-provider/)

A provider for Deno projects. The provider updates the version in deno.json, deno.lock and jsr.json files.

#### Installation


```
pip install commitizen-deno-provider
```

Lee-W marked this conversation as resolved.
Show resolved Hide resolved
#### Usage

Add `deno-provider` to your configuration file.

Example for `.cz.yaml`:

```yml
Lee-W marked this conversation as resolved.
Show resolved Hide resolved
---
commitizen:
major_version_zero: true
name: cz_conventional_commits
tag_format: $version
update_changelog_on_bump: true
version_provider: deno-provider
version_scheme: semver
```
Loading