From 210ca2cfeffed8f6d16d5a0273eba75c2ac06985 Mon Sep 17 00:00:00 2001 From: Dimitri Masson <5263585+dhmmasson@users.noreply.github.com> Date: Mon, 14 Oct 2024 19:53:49 +0000 Subject: [PATCH 1/3] docs(third-party-commitizen): add commitizen-deno-provider to the third party docs --- docs/third-party-commitizen.md | 40 +++++++++++++++++++++++++++++----- 1 file changed, 34 insertions(+), 6 deletions(-) diff --git a/docs/third-party-commitizen.md b/docs/third-party-commitizen.md index dbbd879434..61a1cb3d58 100644 --- a/docs/third-party-commitizen.md +++ b/docs/third-party-commitizen.md @@ -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. @@ -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 @@ -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 @@ -64,10 +65,9 @@ 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`. @@ -75,7 +75,7 @@ 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 @@ -83,4 +83,32 @@ from being used in new commit messages 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 +``` + +#### Usage + +Add `deno-provider` to your configuration file. + +Example for `.cz.yaml`: + +```yml +--- +commitizen: + major_version_zero: true + name: cz_conventional_commits + tag_format: $version + update_changelog_on_bump: true + version_provider: deno-provider + version_scheme: semver +``` From 00d5ab89816fafd735d85d2a93906cfcf7c97631 Mon Sep 17 00:00:00 2001 From: Dimitri Masson <5263585+dhmmasson@users.noreply.github.com> Date: Tue, 15 Oct 2024 11:13:41 +0000 Subject: [PATCH 2/3] docs(third-party-commitizen): update deno-provider code block syntax highlighting --- docs/third-party-commitizen.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/third-party-commitizen.md b/docs/third-party-commitizen.md index 61a1cb3d58..245e35a1da 100644 --- a/docs/third-party-commitizen.md +++ b/docs/third-party-commitizen.md @@ -87,12 +87,12 @@ See the [README][1] for instructions on configuration ### [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. +A provider for Deno projects. The provider updates the version in deno.json and jsr.json files. #### Installation -``` +```sh pip install commitizen-deno-provider ``` @@ -102,7 +102,7 @@ Add `deno-provider` to your configuration file. Example for `.cz.yaml`: -```yml +```yaml --- commitizen: major_version_zero: true From e7045a842e52a6d84a6f790f18bcae2494ec4650 Mon Sep 17 00:00:00 2001 From: Dimitri Masson <5263585+dhmmasson@users.noreply.github.com> Date: Tue, 15 Oct 2024 11:28:26 +0000 Subject: [PATCH 3/3] docs(third-party-commitizen): uniformize the third party page - Create a top level heading for provider to mirror the template heading - Uniformize the installation/usage sub-heading for each template/provider - Uniformize the code-block syntax highlighting --- docs/third-party-commitizen.md | 45 +++++++++++++++++++++++----------- 1 file changed, 31 insertions(+), 14 deletions(-) diff --git a/docs/third-party-commitizen.md b/docs/third-party-commitizen.md index 245e35a1da..1c8ef8a183 100644 --- a/docs/third-party-commitizen.md +++ b/docs/third-party-commitizen.md @@ -9,7 +9,7 @@ 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. -### Installation +#### Installation ```sh pip install conventional-JIRA @@ -23,25 +23,25 @@ This plugin extends the commitizen tools by: - creating links to GitHub commits in the CHANGELOG.md - creating links to JIRA issues in the CHANGELOG.md -### Installation +#### Installation ```sh pip install cz-github-jira-conventional ``` -For installation instructions (configuration and pre-commit) please visit https://github.com/apheris/cz-github-jira-conventional +For installation instructions (configuration and pre-commit) please visit [https://github.com/apheris/cz-github-jira-conventional](https://github.com/apheris/cz-github-jira-conventional) ### [cz-emoji](https://github.com/adam-grant-hendry/cz-emoji) _conventional commit_ format, but with emojis -### Installation +#### Installation ```sh pip install cz-emoji ``` -### Usage +#### Usage ```sh cz --name cz_emoji commit @@ -53,15 +53,15 @@ cz --name cz_emoji commit Includes a pre-commit hook that automatically adds the correct gitmoji to the commit message based on the conventional type. -### Installation +#### Installation -```bash +```sh pip install cz-conventional-gitmoji ``` -### Usage +#### Usage -```bash +```sh cz --name cz_gitmoji commit ``` @@ -69,9 +69,17 @@ cz --name cz_gitmoji commit Just like _conventional commit_ format, but with emojis and optionally time spent and related tasks. -It can be installed with `pip install commitizen-emoji`. +#### Installation + +```sh +pip install commitizen-emoji +``` -Usage: `cz --name cz_commitizen_emoji commit`. +#### Usage + +```sh +cz --name cz_commitizen_emoji commit +``` ### [Conventional Legacy (cz_legacy)][1] @@ -79,19 +87,28 @@ 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` +#### Installation + +```sh +pip install cz_legacy +``` + +#### Usage See the [README][1] for instructions on configuration [1]: https://pypi.org/project/cz_legacy +## Third-Party Commitizen Providers + +Commitizen can read and write version from different sources. In addition to the native providers, some alternative version sources are available as PyPI packages (installable with `pip`). + ### [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. +A provider for **Deno** projects. The provider updates the version in deno.json and jsr.json files. #### Installation - ```sh pip install commitizen-deno-provider ```