Gathering detailed insights and metrics for @digitalroute/cz-conventional-changelog-for-jira
Installations
npm install @digitalroute/cz-conventional-changelog-for-jiraDeveloper Guide
BETA
Typescript
No
Module System
CommonJS
Min. Node Version
>= 10
Node Version
16.20.0
NPM Version
8.19.3
Score
72.3
Supply Chain
93.5
Quality
77.9
Maintenance
100
Vulnerability
95.3
License
Releases
41
Contributors
27
Unable to fetch Contributors
Languages
1
JavaScript
JavaScript (100%)
Love this project? Help keep it running — sponsor us today! 🚀
Developer
digitalroute
Download Statistics
Total Downloads
6,041,417
Last Day
1,677
Last Week
69,371
Last Month
250,315
Last Year
2,512,617
GitHub Statistics
MIT License
66 Stars
111 Commits
62 Forks
2 Watchers
70 Branches
27 Contributors
Updated on Nov 28, 2024
Bundle Size
594.38 kB
Minified
163.04 kB
Minified + Gzipped
Maintainers
6
Package Meta Information
Latest Version
8.0.1
Package Id
@digitalroute/cz-conventional-changelog-for-jira@8.0.1
Unpacked Size
1.61 MB
Size
1.25 MB
File Count
14
NPM Version
8.19.3
Node Version
16.20.0
Published on
May 05, 2023
Total Downloads
Cumulative downloads
Total Downloads
6,041,417
Last Day
12.6%
1,677
Compared to previous day
Last Week
13%
69,371
Compared to previous week
Last Month
54.9%
250,315
Compared to previous month
Last Year
39.9%
2,512,617
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
10
Dev Dependencies
9
Optional Dependencies
1
cz-conventional-changelog-for-jira
Part of the commitizen/cz-cli family. Prompts for conventional changelog standard and also prompts for a mandatory JIRA issue.
Features
- Works seamlessly with semantic-release 🚀
- Works seamlessly with Jira smart commits
- Automatically detects the Jira issue from the branch name
Quickstart
Installation
1npm install commitizen @digitalroute/cz-conventional-changelog-for-jira
and then add the following to package.json:
1{ 2 "scripts": { 3 "commit": "git-cz" 4 }, 5 "config": { 6 "commitizen": { 7 "path": "./node_modules/@digitalroute/cz-conventional-changelog-for-jira" 8 } 9 } 10}
Usage
Configuration
Like commitizen, you can specify the configuration of cz-conventional-changelog-for-jira through the package.json's config.commitizen key, or with environment variables.
| Environment variable | package.json | Default | Description |
|---|---|---|---|
| CZ_JIRA_MODE | jiraMode | true | If this is set to true, CZ will ask for a Jira issue and put it in the commit head. If set to false CZ will ask for the issue in the end, and can be used for GitHub. |
| CZ_MAX_HEADER_WIDTH | maxHeaderWidth | 72 | This limits how long a commit message head can be. |
| CZ_MIN_HEADER_WIDTH | minHeaderWidth | 2 | This limits how short a commit message can be. |
| CZ_MAX_LINE_WIDTH | maxLineWidth | 100 | Commit message bodies are automatically wrapped. This decides how long the lines will be. |
| CZ_SKIP_SCOPE | skipScope | true | If scope should be used in commit messages. |
| CZ_SKIP_TYPE | skipType | false | If type should be used in commit messages. |
| CZ_SKIP_DESCRIPTION | skipDescription | false | If description should be used in commit messages. |
| CZ_SKIP_BREAKING | skipBreaking | false | If breaking changes should be used in commit messages. |
| scopes | undefined | A list (JS Array) of scopes that will be available for selection. Note that adding this will change the scope field from Inquirer 'input' to 'list'. | |
| CZ_TYPE | defaultType | undefined | The default type. |
| CZ_SCOPE | defaultScope | undefined | The default scope. |
| CZ_CUSTOM_SCOPE | customScope | false | Whether user can provide custom scope in addition to predefined ones |
| CZ_SUBJECT | defaultSubject | undefined | A default subject. |
| CZ_BODY | defaultBody | undefined | A default body. |
| CZ_ISSUES | defaultIssues | undefined | A default issue. |
| CZ_JIRA_OPTIONAL | jiraOptional | false | If this is set to true, you can leave the JIRA field blank. |
| CZ_JIRA_PREFIX | jiraPrefix | "DAZ" | If this is set it will be displayed as the default JIRA ticket prefix |
| CZ_JIRA_LOCATION | jiraLocation | "pre-description" | Changes position of JIRA ID. Options: pre-type, pre-description, post-description, post-body |
| CZ_JIRA_PREPEND | jiraPrepend | "" | Prepends JIRA ID with an optional decorator. e.g.: [DAZ-1234 |
| CZ_JIRA_APPEND | jiraAppend | "" | Appends JIRA ID with an optional decorator. e.g.: DAZ-1234] |
| CZ_EXCLAMATION_MARK | exclamationMark | false | On breaking changes, adds an exclamation mark (!) after the scope, e.g.: type(scope)!: break stuff. When activated, reduces the effective allowed header length by 1. |
Jira Location Options
pre-type:
1JIRA-1234 type(scope): commit subject
pre-description:
1type(scope): JIRA-1234 commit subject
post-description:
1type(scope): commit subject JIRA-1234
post-body:
1type(scope): commit subject 2 3JIRA-1234
1type(scope): commit subject 2 3this is a commit body 4 5JIRA-1234
Dynamic Configuration
Alternatively, if you want to create your own profile, you can use the configurable approach. Here is an example: ./index.js
1const custom = require('@digitalroute/cz-conventional-changelog-for-jira/configurable'); 2// You can do this optionally if you want to extend the commit types 3const defaultTypes = require('@digitalroute/cz-conventional-changelog-for-jira/types'); 4 5module.exports = custom({ 6 types: { 7 ...defaultTypes, 8 perf: { 9 description: 'Improvements that will make your code perform better', 10 title: 'Performance' 11 } 12 }, 13 skipScope: false, 14 scopes: ['myScope1', 'myScope2'], 15 customScope: true 16});
./package.json
1{ 2 "config": { 3 "commitizen": { 4 "path": "./index.js" 5 } 6 } 7}
This example would:
- Display "perf" as an extra commit type
- Ask you to add a commit scope
- Limit the scope selection to either
myScopeormyScope2
List of all supported configurable options when using the configurable approach:
| Key | Default | Description |
|---|---|---|
| jiraMode | true | If this is set to true, CZ will ask for a Jira issue and put it in the commit head. If set to false CZ will ask for the issue in the end, and can be used for GitHub. |
| maxHeaderWidth | 72 | This limits how long a commit message head can be. |
| minHeaderWidth | 2 | This limits how short a commit message can be. |
| maxLineWidth | 100 | Commit message bodies are automatically wrapped. This decides how long the lines will be. |
| skipScope | true | If scope should be used in commit messages. |
| defaultType | undefined | The default type. |
| defaultScope | undefined | The default scope. |
| defaultSubject | undefined | A default subject. |
| defaultBody | undefined | A default body. |
| defaultIssues | undefined | A default issue. |
| jiraPrefix | 'DAZ' | The default JIRA ticket prefix that will be displayed. |
| types | ./types.js | A list (JS Object) of supported commit types. |
| scopes | undefined | A list (JS Array) of scopes that will be available for selection. Note that adding this will change the scope field from Inquirer 'input' to 'list'. |
| customScope | false | If this is set to true, users are given an option to provide custom scope aside the ones predefined in 'scopes' array. In this case a new option named 'custom' appears in the list and once chosen a prompt appears to provide custom scope |
| jiraOptional | false | If this is set to true, you can leave the JIRA field blank. |
| jiraLocation | "pre-description" | Changes position of JIRA ID. Options: pre-type, pre-description, post-description, post-body |
| jiraPrepend | "" | Prepends JIRA ID with an optional decorator. e.g.: [DAZ-1234 |
| jiraAppend | "" | Appends JIRA ID with an optional decorator. e.g.: DAZ-1234] |
| exclamationMark | false | On breaking changes, adds an exclamation mark (!) after the scope, e.g.: type(scope)!: break stuff. When activated, reduces the effective allowed header length by 1. |
Commitlint
If using the commitlint js library, the "maxHeaderWidth" configuration property will default to the configuration of the "header-max-length" rule instead of the hard coded value of 72. This can be ovewritten by setting the 'maxHeaderWidth' configuration in package.json or the CZ_MAX_HEADER_WIDTH environment variable.
No vulnerabilities found.
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
Found 23/26 approved changesets -- score normalized to 8
Reason
dependency not pinned by hash detected -- score normalized to 3
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/digitalroute/cz-conventional-changelog-for-jira/release.yml/master?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/release.yml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/digitalroute/cz-conventional-changelog-for-jira/release.yml/master?enable=pin
- Info: 0 out of 2 GitHub-owned GitHubAction dependencies pinned
- Info: 1 out of 1 npmCommand dependencies pinned
Reason
0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Warn: no topLevel permission defined: .github/workflows/release.yml:1
- Info: no jobLevel write permissions found
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 28 are checked with a SAST tool
Reason
12 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5
- Warn: Project is vulnerable to: GHSA-rc47-6667-2j5j
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7
Score
3.8
/10
Last Scanned on 2025-02-10
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More