Skip to content

Latest commit

 

History

History
33 lines (21 loc) · 871 Bytes

README.md

File metadata and controls

33 lines (21 loc) · 871 Bytes
Raw

cfy

Jira integrated commiting CLI mainly to use at colorfy. After installing, just run cfy in any git project

Usage

$ npm install -g @colorfy-software/cfy
$ cfy [In any git project]

$ cfy (-v | --version)

@colorfy-software/cfy/0.0.31 darwin-x64 node-v14.17.6

$ cfy --help [COMMAND]
$ cfy (-t | --ticket) [Take actions only on tickets without doing a commit]

Template

To use a specific style of commits you can use the templating function in ./cfy-config.json. For example add this to the config file after you have run cfy and done initial project setup within a git project:

"wip_flag_template": " | WIP",
"commit_type_case": "uppercase",
"template": "[%JIRA_TICKET_KEY%%WIP_FLAG%] - %COMMIT_TYPE% - %COMMIT_MESSAGE%"

Output: "[JIRA-567 | WIP] - FEAT - Created a feature"