{"id":22894265,"url":"https://github.com/clearcodehq/jira-git-flow","last_synced_at":"2025-03-31T22:38:32.280Z","repository":{"id":69040387,"uuid":"182380057","full_name":"ClearcodeHQ/jira-git-flow","owner":"ClearcodeHQ","description":"Simple CLI tool to manage Jira flow along with the git repository.","archived":false,"fork":false,"pushed_at":"2022-12-26T20:31:16.000Z","size":27,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-30T13:37:09.260Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ClearcodeHQ.png","metadata":{"files":{"readme":"README.md","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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-04-20T08:19:48.000Z","updated_at":"2021-03-02T14:23:12.000Z","dependencies_parsed_at":null,"dependency_job_id":"5d30a60c-c1c2-4e80-b38f-3e0e164d1041","html_url":"https://github.com/ClearcodeHQ/jira-git-flow","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ClearcodeHQ%2Fjira-git-flow","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ClearcodeHQ%2Fjira-git-flow/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ClearcodeHQ%2Fjira-git-flow/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ClearcodeHQ%2Fjira-git-flow/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ClearcodeHQ","download_url":"https://codeload.github.com/ClearcodeHQ/jira-git-flow/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246552972,"owners_count":20795835,"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","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":[],"created_at":"2024-12-13T23:17:21.382Z","updated_at":"2025-03-31T22:38:32.266Z","avatar_url":"https://github.com/ClearcodeHQ.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# jira-git-flow\n\nThe `jira-git-flow` is simple CLI tool to manage Jira flow along with\nthe git repository.\n\nIt allows to manage Jira stories and subtasks in simple way.\nWhen new task is created the git branch with suitable name will be created\nin local repository.\n\nTasks workflow (open -\u003e progress -\u003e review -\u003e done) is managed with cli\ncommands.\n\n## Usage\n\nAvailable commands:\n\n````\n    git-flow --help\n    Usage: git-flow [OPTIONS] COMMAND [ARGS]...\n\n    Git flow.\n\n    Options:\n    --help  Show this message and exit.\n\n    Commands:\n    bug      Create (work on) bugfix.\n    commit   Commit for issue\n    feature  Create (work on) feature.\n    finish   Finish story\n    publish  Push branch to origin\n    resolve  Resolve issue\n    review   Move issue to review\n    start    Start story/task\n    status   Get work status\n    story    Create a story\n    sync     Sync stories between Jira and local storage\n    workon   Work on story/issue.\n````\n\n### status\n\nGet current work status.\n\n### workon\n\nStart working on specific story / task.\n\n#### Chosing from local tasks\n\nWhen command is run without any parameters task will be chosen from local\nstorage.\n\n#### Search Jira for stories\n\nStories can be searched in Jira by adding keywords to command.\nTo get story by issue key use `-k` flag.\n\n### story\n\nCreate new story and start working on it.\n\n### feature / bug\n\nAdd subtask to current story and start working on it.\nSubtask status will be set to `in_progess`. Git branch with suitable\nname will be created on local repo.\n\n### start / review / resolve\n\nChange issue's status.\n\n### commit\n\nMake an git commit. Issue key will be added to the beginning of commit message.\n\n### publish\n\nPublish local branch on remote repository.\n\n### sync\n\nSync local stories will remote Jira state.\n\n## Configuration\n\nTool can be configured via two configuration files:\n\n* credentials.json\n* config.json\n\nBoth configuration files are located in `~/.config/jira-git-flow`.\n\nJira credentials must be set in `credentials.json`.\n\nConfiguration is done via `config.json` file. At the first run default\nconfiguration file is created.\n\n### url\n\nSpecifies base url to Jira instance.\n\n### project\n\nSpecifies proejct key in Jira.\n\n### statuses\n\nThere are following statuses used internally in `jira-git-flow`:\n\n* open\n* in_progress\n* in_review\n* done\n\nStatuses configuration must be set to properly map\nJira statuses to internal ones.\n\nMultiple Jira statues can be mapped to one internal status.\n\n### actions\n\nAction section defines tasks workflow.\nThere are following available actions:\n\n* start_progress\n* review\n* resolve\n\nEach action must define following attributes:\n\n* `current_state` - task state for which action can be applied\n* `transitions` - jira transitions applied to task when action will be performed\n* `next_state` - task state set after action appliance\n\nThere is also optional `assign_to_user`. It specifies if issue should be assign to user on specific action.\n\nDefault actions are defined in `default` dictionary.\n\nWhen specific issue type has it's own actions it can be specified in object\nunder issue type keyword.\n\n### types\nThere are following internal issue types in `jira-git-flow`:\n\n* story\n* feature\n* bug\n\nTypes section allows to define mapping between internal and Jira issue types.\n\nEach type can have a prefix. Prefix will be added to git branch name.\n\n### badges\n\nEach status has a bagde to display in terminal.\nBadges along with their colors can be defined in that section.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclearcodehq%2Fjira-git-flow","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclearcodehq%2Fjira-git-flow","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclearcodehq%2Fjira-git-flow/lists"}