{"id":31608838,"url":"https://github.com/connordelacruz/git-workflow","last_synced_at":"2025-10-06T08:25:15.821Z","repository":{"id":57434892,"uuid":"305818893","full_name":"connordelacruz/git-workflow","owner":"connordelacruz","description":":small_red_triangle: Utilities for streamlining our git workflow.:small_red_triangle_down:","archived":false,"fork":false,"pushed_at":"2025-05-28T15:44:42.000Z","size":1041,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-09-05T13:58:27.768Z","etag":null,"topics":["command-line","git","pypi","python","python3","workflow"],"latest_commit_sha":null,"homepage":"https://pypi.org/project/git-workflow/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/connordelacruz.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-20T19:56:02.000Z","updated_at":"2023-07-28T00:18:54.000Z","dependencies_parsed_at":"2022-09-04T15:32:37.711Z","dependency_job_id":null,"html_url":"https://github.com/connordelacruz/git-workflow","commit_stats":null,"previous_names":[],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/connordelacruz/git-workflow","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/connordelacruz%2Fgit-workflow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/connordelacruz%2Fgit-workflow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/connordelacruz%2Fgit-workflow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/connordelacruz%2Fgit-workflow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/connordelacruz","download_url":"https://codeload.github.com/connordelacruz/git-workflow/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/connordelacruz%2Fgit-workflow/sbom","scorecard":{"id":302735,"data":{"date":"2025-08-11","repo":{"name":"github.com/connordelacruz/git-workflow","commit":"a3b2566049cee7c7b1b00adba5b9006500365127"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"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"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-17T21:09:37.372Z","repository_id":57434892,"created_at":"2025-08-17T21:09:37.373Z","updated_at":"2025-08-17T21:09:37.373Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278578216,"owners_count":26009761,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-06T02:00:05.630Z","response_time":65,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["command-line","git","pypi","python","python3","workflow"],"created_at":"2025-10-06T08:25:13.937Z","updated_at":"2025-10-06T08:25:15.813Z","avatar_url":"https://github.com/connordelacruz.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"==================\nGit Workflow Tools\n==================\n\n|github|\n|pypi|\n|license|\n|pythonversions|\n\n.. |github| image:: https://img.shields.io/badge/GitHub--green.svg?style=social\u0026logo=github\n    :alt: GitHub\n    :target: https://github.com/connordelacruz/git-workflow\n\n.. |pypi| image:: https://img.shields.io/pypi/v/git-workflow.svg\n    :alt: PyPI\n    :target: https://pypi.org/project/git-workflow/\n\n.. |license| image:: https://img.shields.io/pypi/l/git-workflow.svg\n    :alt: License\n\n.. |pythonversions| image:: https://img.shields.io/pypi/pyversions/git-workflow.svg\n    :alt: Python Versions\n    :target: https://pypi.org/project/git-workflow/\n\n\n.. contents::\n    :depth: 2\n\nOverview\n========\n\nThis package contains command line tools to streamline common tasks in our git workflow.\n\nStart New Branch with Commit Template\n-------------------------------------\n\nTo start a new branch, run:\n\n::\n\n    workflow start\n\nThis will prompt you for some information and create a new branch with the following name format:\n\n::\n\n    [\u003cclient\u003e-]\u003cbrief-description\u003e-\u003cyyyymmdd\u003e-\u003cinitials\u003e\n\nIf you provide a ticket number, this will create a git commit message template for the branch. By default, the commit template will be in the following format:\n\n::\n    \n    [\u003cticket#\u003e] \n\nDemos\n~~~~~\n\nStarting a project branch:\n\n.. image:: https://raw.githubusercontent.com/connordelacruz/git-workflow/assets/start/0-start-prompt.gif\n\nCommit message will include the specified ticket number:\n\n.. image:: https://raw.githubusercontent.com/connordelacruz/git-workflow/assets/start/1-commit-message.gif\n\nDifferent branches can use different commit templates:\n\n.. image:: https://raw.githubusercontent.com/connordelacruz/git-workflow/assets/start/2-args-and-per-branch.gif\n\n👆 You can also use command line arguments to skip the prompts. Each workflow\ncommand supports a variety of command line options.\n\n\nFinish a Branch\n---------------\n\nWhen you're finished with a project branch that has been merged, run:\n\n::\n\n    workflow finish\n\nThis will clean up configs, remove the branch's commit template, and delete the branch.\n\nDemo\n~~~~~\n\n.. image:: https://raw.githubusercontent.com/connordelacruz/git-workflow/assets/finish/0-finish.gif\n\n\nCreate a Commit Template for an Existing Branch\n-----------------------------------------------\n\nIf you already have a branch created and would like to create a commit template, run:\n\n::\n\n    workflow set-template\n\nDemo\n~~~~~\n\n.. image:: https://raw.githubusercontent.com/connordelacruz/git-workflow/assets/set-template/0-set-template.gif\n\n\nRemove a Branch's Commit Template\n---------------------------------\n\nTo remove a branch's commit template without deleting the branch, run:\n\n::\n\n    workflow unset-template\n\nDemo\n~~~~~\n\n.. image:: https://raw.githubusercontent.com/connordelacruz/git-workflow/assets/unset-template/0-unset-template.gif\n\n\nCleanup All Commit Templates in a Repo\n--------------------------------------\n\nIf you have a bunch of lingering commit templates and would like to tidy up, run:\n\n::\n\n    workflow cleanup\n\nBy default, this will clean up configs and template files for every branch except the one you have checked out. It will also look for orphaned commit templates with no associated branch and remove them.\n\nDemo\n~~~~~\n\n.. image:: https://raw.githubusercontent.com/connordelacruz/git-workflow/assets/cleanup/0-cleanup.gif\n\n\nSetup\n=====\n\nPrerequisites\n-------------\n\nPython 3.6+\n~~~~~~~~~~~\n\nThis package was developed using features that require **Python 3.6 or greater** (developed using Python 3.9.2).\n\nYou can use `this guide to install Python 3 on macOS \u003chttps://docs.python-guide.org/starting/install3/osx/#doing-it-right\u003e`_.\n\nGit 2.23+\n~~~~~~~~~\n\nThis package uses features that require **Git 2.23 or greater**.\n\nTo install an updated version of ``git`` on macOS using `Homebrew \u003chttps://brew.sh/\u003e`_:\n\n::\n\n    brew install git\n\n**Note:** Make sure ``/usr/local/bin`` is added to your ``PATH``. You can do this by adding the following to your ``.bashrc``:\n\n::\n\n    export PATH=\"/usr/local/bin:$PATH\"\n\n\nInstallation\n------------\n\nOnce you have the above prerequisites installed, you can install it using ``pip`` (or ``pip3`` depending on how you installed Python 3):\n\n::\n\n    pip install git-workflow\n\n\nConfigure Git to Ignore Commit Template Files\n---------------------------------------------\n\nThese commands generate files for commit templates, which you likely do not want to track in your repos.\n\nOption 1: Configure Global .gitignore (RECOMMENDED)\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n1. Create a global gitignore file, e.g. ``~/.gitignore_global``\n2. Set the global git config for ``core.excludesfile`` to the path of your global gitignore, e.g.:\n\n    ::\n\n        git config --global core.excludesfile ~/.gitignore_global\n\n3. Add the following to your global gitignore:\n\n    ::\n\n        # Commit message templates\n        .gitmessage_local*\n\nFor more information on ``core.excludesfile``:\n\n- `GitHub - Ignoring files \u003chttps://docs.github.com/en/github/using-git/ignoring-files#configuring-ignored-files-for-all-repositories-on-your-computer\u003e`_\n- `Git Configuration - core.excludesfile \u003chttps://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration#_core_excludesfile\u003e`_\n\n\nOption 2: Ignore for a Single Repo\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nTo ignore generated template files in a single git repo, add the following to the ``.gitignore`` file:\n\n::\n\n    # Commit message templates\n    .gitmessage_local*\n\n\nConfigure Your Initials\n-----------------------\n\nBy default, ``workflow start`` will prompt you for your initials every time you start a new branch. You can set the git config ``workflow.initials`` to skip this prompt, e.g. to set your initials to \"cd\":\n\n::\n\n    git config --global workflow.initials cd\n\nFor more information, see the `Git Configurations`_ section below.\n\n\n(Optional) Enable Tab Completion for Workflow Commands\n------------------------------------------------------\n\nThis package utilizes `argcomplete \u003chttps://pypi.org/project/argcomplete/\u003e`_ to support tab completion in Bash. Some additional setup is required to enable tab completion.\n\nPrereq: Enable Tab Completion in Bash\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nIf you haven't already, you will need to enable tab completion in Bash. You can follow `this guide to enable Bash Completion on macOS \u003chttps://sourabhbajaj.com/mac-setup/BashCompletion/\u003e`_.\n\nActivate Tab Completion\n~~~~~~~~~~~~~~~~~~~~~~~\n\nAfter setting up tab completion for Bash, you need to activate tab completion for ``argcomplete``. This can be done a couple of ways depending on your Bash version.\n\nOption 1: Activate Global Completion for argcomplete (Bash 4.2+)\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nIf you have Bash 4.2 or greater, you can simply run the following command:\n\n::\n\n    activate-global-python-argcomplete\n\nThen restart Bash for these changes to take effect.\n\n**Note:** The default version of Bash on macOS is 3.2.57. You can follow `this guide to update to a newer version \u003chttps://itnext.io/upgrading-bash-on-macos-7138bd1066ba\u003e`_.\n\nOption 2: Activate Completion for Just This Package\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nIf you're on an older version of Bash or do not want to enable global completion for some reason, add the following to your ``.bash_rc``:\n\n::\n\n    eval \"$(register-python-argcomplete workflow)\"\n\nThen restart Bash for these changes to take effect.\n\n\nWorkflow Commands\n=================\n\n\n**Usage:** ``workflow \u003ccommand\u003e``\n\n``start``\n---------\n\nCreate a new branch with the following name format:\n\n::\n\n    [\u003cclient\u003e-]\u003cbrief-description\u003e-\u003cyyyymmdd\u003e-\u003cinitials\u003e\n\nWhere:\n\n- ``\u003cclient\u003e`` - (Optional) Client's name\n- ``\u003cbrief-description\u003e`` - Description of the work\n- ``\u003cyyyymmdd\u003e`` - Today's date\n- ``\u003cinitials\u003e`` - Engineer's initials\n\nScript will prompt for details and format appropriately (i.e. no\nspaces/underscores, all lowercase).\n\n\nUsage\n~~~~~\n\n::\n\n    usage: workflow start [-h] [-V] [-c \u003cclient\u003e | -C] [-d \u003cdescription\u003e] [-i \u003cinitials\u003e] [-s] [-t \u003cticket#\u003e | -T] [-b \u003cbranch\u003e | -B | -r \u003ctag\u003e] [-P]\n    \n    Create a new branch.\n    \n    General:\n      -h, --help            Show this help message and exit\n      -V, --version         Show version number and exit\n    \n    Branch Name Arguments:\n      -c \u003cclient\u003e, --client \u003cclient\u003e\n                            Specify client name\n      -C, --no-client       No client name (skips prompt)\n      -d \u003cdescription\u003e, --description \u003cdescription\u003e\n                            Specify branch description\n      -i \u003cinitials\u003e, --initials \u003cinitials\u003e\n                            Specify developer initials\n      -s, --skip-bad-name-check\n                            Skip check for bad branch names\n    \n    Commit Template Arguments:\n      -t \u003cticket#\u003e, --ticket \u003cticket#\u003e\n                            Specify ticket number (will create commit template)\n      -T, --no-ticket       Skip ticket number prompt, don't create commit template (overrides -t)\n    \n    Branching Arguments:\n      -b \u003cbranch\u003e, --base-branch \u003cbranch\u003e\n                            Specify branch to use as base for new branch (default: master)\n      -B, --branch-from-current\n                            Use currently checked out branch as base (overrides -b)\n      -r \u003ctag\u003e, --base-release \u003ctag\u003e\n                            Branch from the specified git tag\n      -P, --no-pull         Skip pulling changes to base branch\n    \n\nConfigs\n~~~~~~~\n\nCommand uses the following configs:\n\n- `workflow.initials`_\n- `workflow.baseBranch`_\n- `workflow.badBranchNamePatterns`_\n\n\n``finish``\n----------\n\nFinish a project branch.\n\nBy default, this command will prompt for confirmation unless ``--force`` is\nspecified. Once confirmed, this command will:\n\n- Unset the commit template of the project branch\n- Checkout the base branch and pull latest updates\n- Attempt to delete the project branch using ``git branch -d``, which may\n  fail if the project branch has not been fully merged\n\n\nUsage\n~~~~~\n\n::\n\n    usage: workflow finish [-h] [-V] [-f | -c] [\u003cbranch\u003e]\n    \n    Finish a project branch.\n    \n    General:\n      -h, --help          Show this help message and exit\n      -V, --version       Show version number and exit\n    \n    Positional Arguments:\n      \u003cbranch\u003e            Branch to finish (default: current)\n    \n    Confirmation Prompt Arguments:\n      Override workflow.finishBranchConfirmationPrompt config.\n    \n      -f, --force         Skip confirmation prompt (if configured)\n      -c, --confirmation  Prompt for confirmation before deleting\n    \n\nConfigs\n~~~~~~~\n\nCommand uses the following configs:\n\n- `workflow.baseBranch`_\n- `workflow.finishBranchConfirmationPrompt`_\n\n\n``set-template``\n----------------\n\nCreate and configure commit template for the current branch.\n\nBy default, the commit template includes the specified ticket number before\nthe commit message. E.g. for ticket number ``AB-12345``:\n\n::\n\n    [AB-12345] \u003ccommit message text starts here\u003e\n\nThe commit template file will be created in the root of the git repository.\nBy default, the filename will be in this format:\n\n::\n\n    .gitmessage_local_\u003cticket\u003e_\u003cbranch\u003e\n\nThe format of the filename, commit template body, accepted ticket numbers,\nand more can be customized with git configs (see the Configs section below\nfor details).\n\n\nUsage\n~~~~~\n\n::\n\n    usage: workflow set-template [-h] [-V] [\u003cticket\u003e]\n    \n    Configure git commit template for a branch.\n    \n    General:\n      -h, --help     Show this help message and exit\n      -V, --version  Show version number and exit\n    \n    Positional Arguments:\n      \u003cticket\u003e       Ticket number to use in commit template\n    \n\nConfigs\n~~~~~~~\n\nCommand uses the following configs:\n\n- `workflow.commitTemplateFilenameFormat`_\n- `workflow.commitTemplateFormat`_\n- `workflow.ticketInputFormatRegex`_\n- `workflow.ticketFormatCapitalize`_\n- `workflow.ticketInputFormatRegex`_\n- `workflow.initials`_\n\n\n``unset-template``\n------------------\n\nRemove commmit template for a branch.\n\nBy default, this command will prompt for confirmation before removing the\ncommit template unless ``--force`` is specified.\n\n\nUsage\n~~~~~\n\n::\n\n    usage: workflow unset-template [-h] [-V] [-f | -c] [\u003cbranch\u003e]\n    \n    Remove commit template for a branch.\n    \n    General:\n      -h, --help          Show this help message and exit\n      -V, --version       Show version number and exit\n    \n    Positional Arguments:\n      \u003cbranch\u003e            Branch to unset template for (default: current)\n    \n    Confirmation Prompt Arguments:\n      Override workflow.unsetTemplateConfirmationPrompt config.\n    \n      -f, --force         Skip confirmation prompt (if configured)\n      -c, --confirmation  Prompt for confirmation before unsetting\n    \n\nConfigs\n~~~~~~~\n\nCommand uses the following configs:\n\n- `workflow.unsetTemplateConfirmationPrompt`_\n\n\n``cleanup``\n-----------\n\nTidy up workflow-related files and configs.\n\nThis command will first list all branches and files that will be affected.\nBy default, it will then prompt for confirmation unless ``--force`` is\nspecified. Once confirmed, this command will:\n\n- Unset the commit templates of all configured branches\n- Remove any orphan commit template files that have no associated branch\n\nBy default, the current branch is omitted from cleanup unless\n``--include-current-branch`` is specified.\n\n\nUsage\n~~~~~\n\n::\n\n    usage: workflow cleanup [-h] [-V] [-B] [-o] [-f | -c]\n    \n    Tidy up workflow-related files and configs.\n    \n    General:\n      -h, --help            Show this help message and exit\n      -V, --version         Show version number and exit\n    \n    Cleanup Options:\n      -B, --include-current-branch\n                            Unset template for current branch too\n      -o, --orphans-only    Only clean up templates without a branch\n    \n    Confirmation Prompt Arguments:\n      Override workflow.cleanupConfirmationPrompt config.\n    \n      -f, --force           Skip confirmation prompt (if configured)\n      -c, --confirmation    Prompt for confirmation before cleaning up templates\n    \n\nConfigs\n~~~~~~~\n\nCommand uses the following configs:\n\n- `workflow.cleanupConfirmationPrompt`_\n\n\nGit Configurations\n==================\n\nWorkflow commands will use the following git configs if set:\n\nUser Details\n------------\n\n``workflow.initials``\n~~~~~~~~~~~~~~~~~~~~~\n\nThe user's initials.\n\nIf set, ``workflow start`` will skip the prompt for your initials and use this value.\n\n**E.g.:** To set your initials to \"cd\":\n\n::\n\n    git config --global workflow.initials cd\n\n\nBranches\n--------\n\n``workflow.baseBranch``\n~~~~~~~~~~~~~~~~~~~~~~~\n\n**Default:** ``master``\n\nBranch to use as a base when creating a new branch using ``workflow\nstart``.\n\n**E.g.:** To base branches off of ``develop``:\n\n::\n\n    git config workflow.baseBranch develop\n\n\n``workflow.badBranchNamePatterns``\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nSet to a **space-separated** string of phrases or patterns that\nshould not appear in a standard branch name. If set, ``workflow\nstart`` will check for these before attempting to create a new\nbranch.\n\n**E.g.:** if standard branch names shouldn't include the words\n``-web`` or ``-plugins``:\n\n::\n\n    git config workflow.badBranchNamePatterns \"-web -plugins\"\n\n\nCommit Templates\n----------------\n\n``workflow.commitTemplateFormat``\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n**Default:** ``'[{ticket}] '``\n\nFormat of commit template body. Supports the following placeholders:\n\n  - ``{ticket}``: Replaced with ticket number\n  - ``{branch}``: Replaced with branch name\n  - ``{initials}``: Replaced with user initials (if configured)\n\n\n``workflow.commitTemplateFilenameFormat``\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n**Default:** ``'{ticket}_{branch}'``\n\nFormat of commit template filenames. Supports same placeholders as\n``workflow.commitTemplateFormat``.\n\n**NOTE:** Resulting filenames will always begin with\n``'.gitmessage_local_'``.\n\n\nTicket Numbers\n--------------\n\n``workflow.ticketInputFormatRegex``\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n**Default:** ``'[a-zA-Z]+-[0-9]+'``\n\nRegex representing the format of a valid ticket number. Default\nformat is 1 or more letters, then a hyphen, then 1 or more numbers.\nTo allow any format, set to ``'.*'``.\n\n\n``workflow.ticketFormatCapitalize``\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n**Default:** ``true``\n\nIf ``true``, letters in the ticket number will be capitalized after\nvalidation.\n\n\nConfirmation Prompts\n--------------------\n\n``workflow.finishBranchConfirmationPrompt``\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n**Default:** ``true``\n\nIf ``true``, ``workflow finish`` will prompt for confirmation\nbefore unsetting unless ``-f`` is specified. If ``false``, will\nnot prompt for confirmation unless ``-c`` is specified.\n\n\n``workflow.unsetTemplateConfirmationPrompt``\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n**Default:** ``true``\n\nIf ``true``, ``workflow unset-template`` will prompt for\nconfirmation before unsetting unless ``-f`` is specified. If\n``false``, will not prompt for confirmation unless ``-c`` is\nspecified.\n\n\n``workflow.cleanupConfirmationPrompt``\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n**Default:** ``true``\n\nIf ``true``, ``workflow cleanup`` will prompt for confirmation \nbefore cleaning unless ``-f`` is specified. If ``false``, will not \nprompt for confirmation unless ``-c`` is specified.\n\n\nFuture Updates\n==============\n\nPlanned\n-------\n\n- Config to disable \"Client\" prompt.\n- Add ``-R``/``--branch-from-latest-release`` to ``workflow start``\n\nBackburner\n----------\n\nLow-priority updates that may be added in a future release:\n\n- Generate API docs using Sphinx.\n- Support ``--verbosity`` argument on all commands.\n- ``rename`` command: renames branch while keeping its commit template configured.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconnordelacruz%2Fgit-workflow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fconnordelacruz%2Fgit-workflow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconnordelacruz%2Fgit-workflow/lists"}